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.
Constructors
-
new Extent(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
Object | The cache is used to store values computed from geometries that need to be cleared or recomputed upon mutation. more details | Geometry | |
Point | The center point of the extent in map units. more details | Extent | |
String | The name of the class. more details | Accessor | |
Extent | The extent of the geometry. more details | Geometry | |
Boolean | Indicates if the geometry has M values. more details | Extent | |
Boolean | Indicates if the geometry has z-values (elevation). more details | Extent | |
Number | The height of the extent in map units (the distance between ymin and ymax). more details | Extent | |
Number | The maximum possible | Extent | |
Number | The minimum possible | Extent | |
SpatialReference | The spatial reference of the geometry. more details | Geometry | |
String | For Extent the type is always "extent". more details | Extent | |
Number | The width of the extent in map units (the distance between xmin and xmax). more details | Extent | |
Number | The maximum X-coordinate of an extent envelope. more details | Extent | |
Number | The minimum X-coordinate of an extent envelope. more details | Extent | |
Number | The maximum Y-coordinate of an extent envelope. more details | Extent | |
Number | The minimum Y-coordinate of an extent envelope. more details | Extent | |
Number | The maximum possible | Extent | |
Number | The minimum possible | Extent |
Property Details
-
The cache is used to store values computed from geometries that need to be cleared or recomputed upon mutation. An example is the extent of a polygon.
-
center Pointreadonly
-
The center point of the extent in map units.
-
Since: ArcGIS Maps SDK for JavaScript 4.7
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
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
-
-
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)
-
width Numberreadonly
-
-
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
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
Extent | Centers the extent to the specified Point. more details | Extent | |
Extent | Creates a deep clone of Extent object. more details | Extent | |
Boolean | Checks if the input geometry is contained within the extent. more details | Extent | |
Boolean | Indicates if the input extent is equal to the testing extent. more details | Extent | |
Extent | Expands the extent by the given factor. more details | Extent | |
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. more details | Geometry | |
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Extent | Shrinks the original extent to the intersection with the input extent. more details | Extent | |
Boolean | Tests to validate if the input geometry intersects the extent and returns a Boolean value. more details | Extent | |
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. more details | Extent | |
Extent | Modifies the extent geometry in-place with X and Y offsets in map units. more details | Extent | |
Removes a group of handles owned by the object. more details | Accessor | ||
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | Geometry | |
Extent | Expands the original extent to include the extent of the input Extent. more details | Extent |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
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.
Parameterpoint PointThe point to center the extent.
ReturnsType Description Extent The new extent with point
as the center.
-
clone(){Extent}
-
Creates a deep clone of Extent object.
ReturnsType 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.
ParameterInput geometry to test if it is contained within the extent.
ReturnsType 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.
Parameterextent ExtentInput extent.
ReturnsType Description Boolean Returns true
if the input extent is equal to the extent that callsequals()
.
-
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.
Parameterfactor NumberThe multiplier value.
ReturnsType 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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
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.
Parameterextent ExtentThe input extent to intersect.
ReturnsType 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.
Parametergeometry GeometryThe geometry used to test the intersection. It can be a Point, Polyline, Polygon, Extent or Multipoint.
ReturnsType Description Boolean Returns true
, if the input geometry intersects the 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.
ReturnsType 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.
Parametersdx NumberThe offset distance in map units for the X-coordinate.
dy NumberThe offset distance in map units for the Y-coordinate.
dz NumberThe offset distance in map units for the Z-coordinate.
ReturnsType Description Extent The offset Extent.
-
removeHandles(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType 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.
Parameterextent ExtentThe input extent to union.
ReturnsType Description Extent The union of the input Extent with the original Extent.