Class EsriExtent

Hierarchy

EsriGeometry
- EsriExtent

Index

Constructors

Properties

cache center declaredClass destroyed extent hasM hasZ height initialized mmax mmin spatialReference type width xmax xmin ymax ymin zmax zmin

Methods

_get _set addHandles centerAt clone contains destroy equals expand get hasHandles intersection intersects normalize notifyChange offset own removeHandles set toJSON union watch fromJSON

Constructors

constructor

new EsriExtent(properties?): EsriExtent
The minimum and maximum X and Y coordinates of a bounding box.

Read more...
Parameters
- Optional properties: ExtentProperties
Returns EsriExtent
Overrides EsriGeometry.constructor
- Defined in node_modules/@arcgis/core/interfaces.d.ts:4643

Properties

`Readonly` cache

cache: any

The cache is used to store values computed from geometries that need to be cleared or recomputed upon mutation.

`Readonly` center

center: EsriPoint

The center point of the extent in map units.

declaredClass

declaredClass: string

destroyed

destroyed: boolean

`Readonly` extent

extent: EsriExtent

The extent of the geometry.

hasM

hasM: boolean

Indicates if the geometry has M values.

hasZ

hasZ: boolean

Indicates if the geometry has z-values (elevation).

`Readonly` height

height: number

The height of the extent in map units (the distance between ymin and ymax).

initialized

initialized: boolean

mmax

mmax: number

The maximum possible m value in an extent envelope.

Default

undefined

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#mmax)

mmin

mmin: number

The minimum possible m value of an extent envelope.

Default

undefined

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#mmin)

spatialReference

spatialReference: EsriSpatialReference

The spatial reference of the geometry.

Default

WGS84 (wkid: 4326)

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html#spatialReference)

`Readonly` type

type: "extent"

The geometry type.

`Readonly` width

width: number

The width of the extent in map units (the distance between xmin and xmax).

xmax

xmax: number

The maximum X-coordinate of an extent envelope.

Default

0

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#xmax)

xmin

xmin: number

The minimum X-coordinate of an extent envelope.

Default

0

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#xmin)

ymax

ymax: number

The maximum Y-coordinate of an extent envelope.

Default

0

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#ymax)

ymin

ymin: number

The minimum Y-coordinate of an extent envelope.

Default

0

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#ymin)

zmax

zmax: number

The maximum possible z, or elevation, value in an extent envelope.

Default

undefined

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#zmax)

zmin

zmin: number

The minimum possible z, or elevation, value of an extent envelope.

Default

undefined

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#zmin)

Methods

`Protected` _get

_get(propertyName): any
Parameters
- propertyName: string
Returns any
Inherited from EsriGeometry._get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:32
_get<T>(propertyName): T
Type Parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from EsriGeometry._get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:33

`Protected` _set

_set<T>(propertyName, value): EsriExtent
Type Parameters
- T
Parameters
- propertyName: string
- value: T
Returns EsriExtent
Inherited from EsriGeometry._set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:34

addHandles

addHandles<T>(handles, groupKey?): void
Type Parameters
- T
Parameters
- handles: IHandle | IHandle[]
- Optional groupKey: Exclude<T, IHandle>
Returns void
Inherited from EsriGeometry.addHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:28

centerAt

centerAt(point): EsriExtent
Centers the extent to the specified Point.

Read more...
Parameters
- point: EsriPoint
Returns EsriExtent
- Defined in node_modules/@arcgis/core/interfaces.d.ts:4649

clone

clone(): EsriExtent
Creates a deep clone of Extent object.

Read more...

Returns EsriExtent
Overrides EsriGeometry.clone
- Defined in node_modules/@arcgis/core/interfaces.d.ts:4655

contains

contains(geometry): boolean
Checks if the input geometry is contained within the extent.

Read more...
Parameters
- geometry: EsriExtent | EsriPoint
Returns boolean
- Defined in node_modules/@arcgis/core/interfaces.d.ts:4661

destroy

destroy(): void
Returns void
Inherited from EsriGeometry.destroy
- Defined in node_modules/@arcgis/core/interfaces.d.ts:20

equals

equals(extent): boolean
Indicates if the input extent is equal to the testing extent.

Read more...
Parameters
- extent: EsriExtent
Returns boolean
- Defined in node_modules/@arcgis/core/interfaces.d.ts:4667

expand

expand(factor): EsriExtent
Expands the extent by the given factor.

Read more...
Parameters
- factor: number
Returns EsriExtent
- Defined in node_modules/@arcgis/core/interfaces.d.ts:4673

get

get<T>(propertyName): T
Type Parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from EsriGeometry.get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:21
get(propertyName): any
Parameters
- propertyName: string
Returns any
Inherited from EsriGeometry.get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:22

hasHandles

hasHandles<T>(groupKey?): boolean
Type Parameters
- T
Parameters
- Optional groupKey: Exclude<T, IHandle>
Returns boolean
Inherited from EsriGeometry.hasHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:30

intersection

intersection(extent): EsriExtent
Shrinks the original extent to the intersection with the input extent.

Read more...
Parameters
- extent: EsriExtent
Returns EsriExtent
- Defined in node_modules/@arcgis/core/interfaces.d.ts:4679

intersects

intersects(geometry): boolean
Tests to validate if the input geometry intersects the extent and returns a Boolean value.

Read more...
Parameters
- geometry: EsriGeometry
Returns boolean
- Defined in node_modules/@arcgis/core/interfaces.d.ts:4685

normalize

normalize(): EsriExtent[]
Returns an array with either one Extent that's been shifted to within +/- 180 or two Extents if the original extent intersects the International Dateline.

Read more...

Returns EsriExtent[]
- Defined in node_modules/@arcgis/core/interfaces.d.ts:4691

`Protected` notifyChange

notifyChange(propertyName): void
Parameters
- propertyName: string
Returns void
Inherited from EsriGeometry.notifyChange
- Defined in node_modules/@arcgis/core/interfaces.d.ts:31

offset

offset(dx, dy, dz): EsriExtent
Modifies the extent geometry in-place with X and Y offsets in map units.

Read more...
Parameters
- dx: number
- dy: number
- dz: number
Returns EsriExtent
- Defined in node_modules/@arcgis/core/interfaces.d.ts:4697

own

own(handles): void
Deprecated
Since 4.25. Use addHandles(), removeHandles() and hasHandles() instead.
Parameters
- handles: IHandle | IHandle[]
Returns void
Inherited from EsriGeometry.own
- Defined in node_modules/@arcgis/core/interfaces.d.ts:27

removeHandles

removeHandles<T>(groupKey?): void
Type Parameters
- T
Parameters
- Optional groupKey: Exclude<T, IHandle>
Returns void
Inherited from EsriGeometry.removeHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:29

set

set<T>(propertyName, value): EsriExtent
Type Parameters
- T
Parameters
- propertyName: string
- value: T
Returns EsriExtent
Inherited from EsriGeometry.set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:23
set(props): EsriExtent
Parameters
- props: HashMap<any>
Returns EsriExtent
Inherited from EsriGeometry.set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:24

toJSON

toJSON(): any
Converts an instance of this class to its ArcGIS portal JSON representation.

Read more...

Returns any
Inherited from EsriGeometry.toJSON
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2167

union

union(extent): EsriExtent
Expands the original extent to include the extent of the input Extent.

Read more...
Parameters
- extent: EsriExtent
Returns EsriExtent
- Defined in node_modules/@arcgis/core/interfaces.d.ts:4703

watch

watch(path, callback, sync?): WatchHandle
Parameters
- path: string | string[]
- callback: WatchCallback
- Optional sync: boolean
Returns WatchHandle
Inherited from EsriGeometry.watch
- Defined in node_modules/@arcgis/core/interfaces.d.ts:25

`Static` fromJSON

fromJSON(json): EsriExtent
Parameters
- json: any
Returns EsriExtent
Overrides EsriGeometry.fromJSON
- Defined in node_modules/@arcgis/core/interfaces.d.ts:4704

Class EsriExtent

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional properties: ExtentProperties

Returns EsriExtent

Properties

Readonly cache

Readonly center

declaredClass

destroyed

Readonly extent

hasM

hasZ

Readonly height

initialized

mmax

Default

mmin

Default

spatialReference

Default

Readonly type

Readonly width

xmax

Default

xmin

Default

ymax

Default

ymin

Default

zmax

Default

zmin

Default

Methods

Protected _get

Parameters

propertyName: string

Returns any

Type Parameters

T

Parameters

propertyName: string

Returns T

Protected _set

Type Parameters

T

Parameters

propertyName: string

value: T

Returns EsriExtent

addHandles

Type Parameters

T

Parameters

handles: IHandle | IHandle[]

Optional groupKey: Exclude<T, IHandle>

Returns void

centerAt

Parameters

point: EsriPoint

Returns EsriExtent

clone

Returns EsriExtent

contains

Parameters

geometry: EsriExtent | EsriPoint

Returns boolean

destroy

Returns void

equals

Parameters

extent: EsriExtent

`Optional` properties: ExtentProperties

`Readonly` cache

`Readonly` center

`Readonly` extent

`Readonly` height

`Readonly` type

`Readonly` width

`Protected` _get

`Protected` _set

`Optional` groupKey: Exclude<T, IHandle>

`Optional` groupKey: Exclude<T, IHandle>

`Protected` notifyChange

`Optional` groupKey: Exclude<T, IHandle>