Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: Extent
[ AMD Module Require | Legacy Module Require ]
dojo.require("esri.geometry.Extent")
Description
(Added at v1.0)
The minimum and maximum X- and Y- coordinates of a bounding box.Samples
Search for samples that use this class.Class hierarchy
esri/geometry.Geometry |_esri/geometry.Extent
Constructors
| Name | Summary |
|---|---|
| new esri.geometry.Extent(xmin, ymin, xmax, ymax, spatialReference) | Creates a new Extent object. |
| new esri.geometry.Extent(json) | Creates a new Extent object using a JSON object. |
Properties
| Name | Type | Summary |
|---|---|---|
| cache | Object | The cache is used to store values computed from geometries that need to cleared or recomputed upon mutation. |
| spatialReference | SpatialReference | The spatial reference of the geometry. |
| type | String | The type of geometry. |
| xmax | Number | Top-right X-coordinate of an extent envelope. |
| xmin | Number | Bottom-left X-coordinate of an extent envelope. |
| ymax | Number | Top-right Y-coordinate of an extent envelope. |
| ymin | Number | Bottom-left Y-coordinate of an extent envelope. |
Methods
| Name | Return type | Summary |
|---|---|---|
| centerAt(point) | Extent | A new extent is returned with the same width and height centered at the argument point. |
| clearCache() | None | Sets the cache property to undefined. |
| contains(geometry) | Boolean | When "true", the geometry in the argument is contained in this extent. |
| expand(factor) | Extent | Expands the extent by the factor given. |
| getCacheValue(name) | Object | Returns the value for a named property stored in the cache. |
| getCenter() | Point | Returns the center point of the extent in map units. |
| getHeight() | Number | Distance between ymin and ymax. |
| getWidth() | Number | Distance between xmin and xmax. |
| intersects(geometry) | Extent | Boolean | Returns the intersection extent if the input geometry is an extent that intersects this 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 dateline. |
| offset(dx, dy) | Extent | Returns a new Extent with x and y offsets. |
| setCacheValue(name, value) | None | Sets the value for a named property stored in the cache. |
| setSpatialReference(sr) | Geometry | Sets the spatial reference. |
| shiftCentralMeridian() | Extent | Returns an extent with a spatial reference with a custom shifted central meridian if the extent intersects the dateline. |
| toJson() | Object | Converts object to its ArcGIS Server JSON representation. |
| union(extent) | Extent | Expands this extent to include the extent of the argument.NOTE: Performing a Union returns a new extent as opposed to modifying the existing extent.. |
| update(xmin, ymin, xmax, ymax, spatialReference) | Extent | Updates this extent with the specified parameters. |
Constructor Details
Creates a new Extent object. The coordinates represent the lower left and upper right corners of the bounding box. A spatial reference is also required.
Parameters:
< |
Required | Bottom-left X-coordinate of an extent envelope. |
< |
Required | Bottom-left Y-coordinate of an extent envelope. |
< |
Required | Top-right X-coordinate of an extent envelope. |
< |
Required | Top-right Y-coordinate of an extent envelope. |
< |
Required | Spatial reference of the geometry. |
Sample:
var extent = new esri.geometry.Extent(-122.68,45.53,-122.45,45.60, new esri.SpatialReference({ wkid:4326 }));
Creates a new Extent object using a JSON object.
Parameters:
< |
Required | JSON object representing the geometry. |
Sample:
var extent = new esri.geometry.Extent({"xmin":-122.68,"ymin":45.53,"xmax":-122.45,"ymax":45.6,
"spatialReference":{"wkid":4326}});
Property Details
<Object
ObjectThe 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. The default value is
undefined. (Added at v3.13)Default value:
undefined<SpatialReference
SpatialReferenceThe spatial reference of the geometry. See Projected Coordinate Systems and Geographic Coordinate Systems for the list of supported spatial references.
<Number
NumberTop-right X-coordinate of an extent envelope.
<Number
NumberBottom-left X-coordinate of an extent envelope.
<Number
NumberTop-right Y-coordinate of an extent envelope.
<Number
NumberBottom-left Y-coordinate of an extent envelope.
Method Details
A new extent is returned with the same width and height centered at the argument point.
Return type:
ExtentParameters:
< |
Required | Centers the extent on the specified x,y location. |
When "true", the geometry in the argument is contained in this extent.
Return type:
BooleanSample:
var extent = map.extent;
if(extent.contains(graphic.geometry)) {
graphic.setSymbol(highlightSymbol);
}
Expands the extent by the factor given. For example, a value of 1.5 will be 50% bigger.
Return type:
ExtentParameters:
< |
Required | The multiplier value. |
Sample:
map.setExtent(points.getExtent().expand(3));
Returns the value for a named property stored in the cache. (Added at v3.13)
Return type:
ObjectParameters:
< |
Required | The property name of the value to retrieve from the cache. |
Returns the intersection extent if the input geometry is an extent that intersects this extent. Boolean is returned when passing in non-Extent geometry types.
Parameters:
< |
Required | The geometry used to test the intersection. Valid geometry includes Point, Multipoint, Extent, Polygon, or Polyline. |
Sample:
var polygonExtent = polygon.getExtent();
if (polygonExtent.intersects(map.extent)) {
alert("Polygon intersects current map extent");
}
Returns an array with either one Extent that's been shifted to within +/- 180 or two Extents if the original extent intersects the dateline. (Added at v3.12)
Return type:
Extent[]Returns a new Extent with x and y offsets. Units are map units.
Return type:
ExtentSets the value for a named property stored in the cache. (Added at v3.13)
Sets the spatial reference.
Return type:
GeometryParameters:
< |
Required | Spatial reference of the geometry. |
Returns an extent with a spatial reference with a custom shifted central meridian if the extent intersects the dateline. (Added at v3.12)
Return type:
ExtentExpands this extent to include the extent of the argument.NOTE: Performing a Union returns a new extent as opposed to modifying the existing extent.
Return type:
ExtentParameters:
< |
Required | The minx, miny, maxx, and maxy bounding box. |
Updates this extent with the specified parameters.
Return type:
ExtentParameters:
< |
Required | Bottom-left X-coordinate of an extent envelope. |
< |
Required | Bottom-left Y-coordinate of an extent envelope. |
< |
Required | Top-right X-coordinate of an extent envelope. |
< |
Required | Top-right Y-coordinate of an extent envelope. |
< |
Required | Spatial reference of the geometry. |