Extent

AMD: require(["esri/geometry/Extent"], (Extent) => { /* code goes here */ });
ESM: import Extent from "@arcgis/core/geometry/Extent";
Class: esri/geometry/Extent
Inheritance: Extent Geometry Accessor
Since: ArcGIS API for JavaScript 4.0

The minimum and maximum X and Y coordinates of a bounding box. Extent is used to describe the visible portion of a MapView. When working in a SceneView, Camera is used to define the visible part of the map within the view.

See also:

Constructors

new Extent(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Objectmore details

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

more detailsGeometry
Pointmore details

The center point of the extent in map units.

more detailsExtent
Stringmore details

The name of the class.

more detailsAccessor
Extentmore details

The extent of the geometry.

more detailsGeometry
Booleanmore details

Indicates if the geometry has M values.

more detailsExtent
Booleanmore details

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

more detailsExtent
Numbermore details

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

more detailsExtent
Numbermore details

The maximum possible m value in an extent envelope.

more detailsExtent
Numbermore details

The minimum possible m value of an extent envelope.

more detailsExtent
SpatialReferencemore details

The spatial reference of the geometry.

more detailsGeometry
Stringmore details For Extent the type is always "extent". more detailsExtent
Numbermore details

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

more detailsExtent
Numbermore details

The maximum X-coordinate of an extent envelope.

more detailsExtent
Numbermore details

The minimum X-coordinate of an extent envelope.

more detailsExtent
Numbermore details

The maximum Y-coordinate of an extent envelope.

more detailsExtent
Numbermore details

The minimum Y-coordinate of an extent envelope.

more detailsExtent
Numbermore details

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

more detailsExtent
Numbermore details

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

more detailsExtent

Property Details

cache Objectreadonly 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.

center Pointreadonly

The center point of the extent in map units.

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

extent Extentreadonly inherited

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

hasM Booleanreadonly

Indicates if the geometry has M values.

hasZ Booleanreadonly

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

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.

height Numberreadonly

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

mmax Number

The maximum possible m value in an extent envelope.

Default Value:undefined
mmin Number

The minimum possible m value of an extent envelope.

Default Value:undefined

The spatial reference of the geometry.

Default Value:WGS84 (wkid: 4326)
type Stringreadonly

For Extent the type is always "extent".

width Numberreadonly

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

xmax Number

The maximum X-coordinate of an extent envelope.

Default Value:0
xmin Number

The minimum X-coordinate of an extent envelope.

Default Value:0
ymax Number

The maximum Y-coordinate of an extent envelope.

Default Value:0
ymin Number

The minimum Y-coordinate of an extent envelope.

Default Value:0
zmax Number

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
zmin Number

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

Show inherited methods Hide inherited methods
Name Return Type Summary Class
Extentmore details

Centers the extent to the specified Point.

more detailsExtent
Extentmore details

Creates a deep clone of Extent object.

more detailsExtent
Booleanmore details

Checks if the input geometry is contained within the extent.

more detailsExtent
Booleanmore details

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

more detailsExtent
Extentmore details

Expands the extent by the given factor.

more detailsExtent
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsGeometry
Extentmore details

Shrinks the original extent to the intersection with the input extent.

more detailsExtent
Booleanmore details

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

more detailsExtent
Extent[]more details

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.

more detailsExtent
Extentmore details

Modifies the extent geometry in-place with X and Y offsets in map units.

more detailsExtent
Objectmore details

Converts an instance of this class to its ArcGIS portal JSON representation.

more detailsGeometry
Extentmore details

Expands the original extent to include the extent of the input Extent.

more detailsExtent

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 an ArcGIS product. 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() guide topic 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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.