Hide Table of Contents
esri
arcgis
dijit
geometry
layers
renderer
symbols
tasks
Class: Extent
[ AMD Module Require | Legacy Module Require ]
Description
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
| Constructor | Description |
|---|---|
| new esri.geometry.Extent(xmin,ymin,xmax,ymax,spatialReference) | 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. |
| new esri.geometry.Extent(json) | Creates a new Extent object using a JSON object. |
Properties
| Property | Type | Description |
|---|---|---|
| spatialReference | SpatialReference | The spatial reference of the geometry. See Projected Coordinate Systems and Geographic Coordinate Systems for the list of supported spatial references. |
| 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
| Method | Return Value | Description |
|---|---|---|
| centerAt(point) | Extent | A new extent is returned with the same width and height centered at the argument point. |
| 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. For example, a value of 1.5 will be 50% bigger. |
| 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 interesection extent if the input geometry is an extent that intersects this extent. Boolean is returned when passing in non-Extent geometry types. |
| offset(dx,dy) | Extent | Offsets the current extent. Units are map units. |
| setSpatialReference(sr) | Geometry | Sets the spatial reference. The return value of Geometry was added at v1.4. |
| toJson() | Object | Converts object to its ArcGIS Server JSON representation. |
| union(extent) | Extent | Expands this extent to include the extent of the argument. |
| update(xmin,ymin,xmax,ymax,spatialReference) | Extent | Updates this extent with the specified parameters. The return value of Extent was added at v1.4. |
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:
| <Number> xmin | Required | Bottom-left X-coordinate of an extent envelope. |
| <Number> ymin | Required | Bottom-left Y-coordinate of an extent envelope. |
| <Number> xmax | Required | Top-right X-coordinate of an extent envelope. |
| <Number> ymax | Required | Top-right Y-coordinate of an extent envelope. |
| <SpatialReference> spatialReference | Required | Spatial reference of the geometry. |
Code Snippet:
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:
| <Object> json | Required | JSON object representing the geometry. |
Code Snippet:
var extent = new esri.geometry.Extent({"xmin":-122.68,"ymin":45.53,"xmax":-122.45,"ymax":45.6,
"spatialReference":{"wkid":4326}});
Property Details
<SpatialReference> spatialReference
The spatial reference of the geometry. See Projected Coordinate Systems and Geographic Coordinate Systems for the list of supported spatial references.
Method Details
A new extent is returned with the same width and height centered at the argument point.
Return Value: Extent
Input Parameters:
| <Point> point | Required | Centers the extent on the specified x,y location. |
When "true", the geometry in the argument is contained in this extent.
Return Value: Boolean
Input Parameters:
| <Geometry> geometry | Required | Can be a Point or Extent.
Prior to version 2.0, the first parameter was
|
Code Snippet:
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 Value: Extent
Input Parameters:
| <Number> factor | Required | The multiplier value. |
Code Snippet:
map.setExtent(points.getExtent().expand(3));
Returns the interesection extent if the input geometry is an extent that intersects this extent. Boolean is returned when passing in non-Extent geometry types.
Return Value: Extent | Boolean
Input Parameters:
| <Geometry> geometry | Required | The geometry used to test the intersection. Valid geometry includes Point, Multipoint, Extent, Polygon, or Polyline.
Prior to version 2.0, the first parameter was
|
Code Snippet:
var polygonExtent = polygon.getExtent();
if (polygonExtent.intersects(map.extent)) {
alert("Polygon intersects current map extent");
}
Offsets the current extent. Units are map units.
Return Value: Extent
Input Parameters:
| <Number> dx | Required | The offset distance in map units for the y-coordinate. |
| <Number> dy | Required | The offset distance in map units for the x-coordinate. |
Sets the spatial reference.
The return value of
The return value of
Geometry was added at v1.4.Return Value: Geometry
Input Parameters:
| <SpatialReference> sr | Required | Spatial reference of the geometry. |
Expands this extent to include the extent of the argument.
Return Value: Extent
Input Parameters:
| <Extent> extent | Required | The minx, miny, maxx, and maxy bounding box. |
Updates this extent with the specified parameters.
The return value of
The return value of
Extent was added at v1.4.Return Value: Extent
Input Parameters:
| <Number> xmin | Required | Bottom-left X-coordinate of an extent envelope. |
| <Number> ymin | Required | Bottom-left Y-coordinate of an extent envelope. |
| <Number> xmax | Required | Top-right X-coordinate of an extent envelope. |
| <Number> ymax | Required | Top-right Y-coordinate of an extent envelope. |
| <SpatialReference> spatialReference | Required | Spatial reference of the geometry. |