Property Overview

Property Details

cacheObjectreadonly inherited

The cache is used to store values computed from geometries that need to cleared or recomputed upon mutation. An example is the extent of a polygon.

centerPointreadonly

The center point of the extent in map units.

declaredClassStringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

extentExtentreadonly inherited

The extent of the geometry. For a point, the extent is null.

hasMBooleanreadonly

Indicates if the geometry has M values.

hasZBooleanreadonly

Indicates if the geometry has Z (elevation) values.

Z-values defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service.

heightNumberreadonly

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

mmaxNumber

The maximum possible m value in an extent envelope.

Default Value:undefined

mminNumber

The minimum possible m value of an extent envelope.

Default Value:undefined

spatialReferenceSpatialReferenceautocast inherited

The spatial reference of the geometry.

Default Value:WGS84 (wkid: 4326)

typeStringreadonly

For Extent, the type is always extent.

widthNumberreadonly

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

xmaxNumber

The bottom-right X-coordinate of an extent envelope.

Default Value:0

xminNumber

The top-left X-coordinate of an extent envelope.

Default Value:0

ymaxNumber

The top-right Y-coordinate of an extent envelope.

Default Value:0

yminNumber

The bottom-left Y-coordinate of an extent envelope.

Default Value:0

zmaxNumber

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

Z-values defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service.

Default Value:undefined

zminNumber

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

Z-values defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service.

Default Value:undefined

Method Overview

Method Details

centerAt(point){Extent}

Centers the extent to the specified Point. This method modifies the extent geometry in-place. You should clone the extent object before calling this method where appropriate.

Parameter:

point Point The point to center the extent.

Returns:

Type	Description
Extent	The new extent with point as the center.

clone(){Extent}

Creates a deep clone of Extent object.

Returns:

Type	Description
Extent	A new instance of a Extent object equal to the object used to call .clone().

contains(geometry){Boolean}

Checks if the input geometry is contained within the extent.

Parameter:

geometry Point|Extent Input geometry to test if it is contained within the extent.

Returns:

Type	Description
Boolean	Returns true if the input geometry is contained within the extent.

equals(extent){Boolean}

Indicates if the input extent is equal to the testing extent.

Parameter:

extent Extent Input extent.

Returns:

Type	Description
Boolean	Returns true if the input extent is equal to the extent that calls equals().

expand(factor){Extent}

Expands the extent by the given factor. For example, a value of 1.5 will expand the extent to be 50 percent larger than the original extent. This method modifies the extent geometry in-place. You should clone the extent object before calling this method where appropriate.

Parameter:

factor Number The multiplier value.

Returns:

Type	Description
Extent	Returns the expanded extent.

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:

json Object A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:

Type	Description
*	Returns a new instance of this class.

intersection(extent){Extent}

Shrinks the original extent to the intersection with the input extent. This method modifies the extent geometry in-place. You should clone the extent object before calling this method where appropriate. If the original extent and the input extent have no intersection, the extent is not modified and null is returned.

Parameter:

extent Extent The input extent to intersect.

Returns:

Type	Description
Extent	The intersection of the input Extent with the original Extent or null.

intersects(geometry){Boolean}

Tests to validate if the input geometry intersects the extent and returns a Boolean value.

Parameter:

geometry Geometry The geometry used to test the intersection. It can be a Point, Polyline, Polygon, Extent or Multipoint.

Returns:

Type	Description
Boolean	Returns true, if the input geometry intersects the extent.

normalize(){Extent[]}

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.

This method modifies the extent geometry in-place. You should clone the extent object before calling this method where appropriate.

Returns:

Type	Description
Extent[]	The normalized Extent(s).

offset(dx, dy, dz){Extent}

Modifies the extent geometry in-place with X and Y offsets in map units. You should clone the extent object before calling this method where appropriate.

Parameters:

dx Number The offset distance in map units for the X-coordinate.

dy Number The offset distance in map units for the Y-coordinate.

dz Number The offset distance in map units for the Z-coordinate.

Returns:

Type	Description
Extent	The offset Extent.

toJSON(){Object}inherited

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() topic in the Guide for more information.

Returns:

Type	Description
Object	The ArcGIS portal JSON representation of an instance of this class.

union(extent){Extent}

Expands the original extent to include the extent of the input Extent. This method modifies the extent geometry in-place. You should clone the extent object before calling this method where appropriate.

Parameter:

extent Extent The input extent to union.

Returns:

Type	Description
Extent	The union of the input Extent with the original Extent.