Summary
An extent is a rectangle specified by providing the coordinate of the lower left corner and the coordinate of the upper right corner in map units.
Discussion
The Extent object supports equal (==) and not equal (!=) operators for comparing extents.
Note:
When used as input to ArcGIS Spatial Analyst extension tools—Create Constant Raster, Create Normal Raster, Create Random Raster, Extract By Rectangle, Extract by Mask, and Topo To Raster—only the XMin, YMin, XMax, and YMax values are used by these tools.
Syntax
Extent ({XMin}, {YMin}, {XMax}, {YMax}, {ZMin}, {ZMax}, {MMin}, {MMax}, {spatial_reference})
Parameter | Explanation | Data Type |
XMin | The extent XMin value. | Double |
YMin | The extent YMin value. | Double |
XMax | The extent XMax value. | Double |
YMax | The extent YMax value. | Double |
ZMin | The extent ZMin value. None if no z-value. | Double |
ZMax | The extent ZMax value. None if no z-value. | Double |
MMin | The extent MMin value. None if no m-value. | Double |
MMax | The extent MMax value. None if no m-value. | Double |
spatial_reference | The spatial reference of the extent. | SpatialReference |
Properties
Property | Explanation | Data Type |
JSON (Read Only) | Returns a JSON representation of the extent as a string. Tip:The returned string can be converted to a dictionary using the json module's loads function. | String |
MMax (Read Only) | The extent MMax value. None if no m-value. | Double |
MMin (Read Only) | The extent MMin value. None if no m-value. | Double |
XMax (Read Only) | The extent XMax value. | Double |
XMin (Read Only) | The extent XMin value. | Double |
YMax (Read Only) | The extent YMax value. | Double |
YMin (Read Only) | The extent YMin value. | Double |
ZMax (Read Only) | The extent ZMax value. None if no z-value. | Double |
ZMin (Read Only) | The extent ZMin value. None if no z-value. | Double |
depth (Read Only) | The extent depth value. None if no depth. | Double |
geohash (Read Only) | A geohash string of the extent is returned. | String |
geohashCovers (Read Only) | Returns a list of up to the four longest geohash strings that fit within the extent. | String |
geohashNeighbors (Read Only) | A list of the geohash neighbor strings for the extent is returned. | String |
height (Read Only) | The extent height value. | Double |
lowerLeft (Read Only) | The lower left property: A point object is returned. | Point |
lowerRight (Read Only) | The lower right property: A point object is returned. | Point |
polygon (Read Only) | Returns the extent as a polygon object. | Polygon |
spatialReference (Read Only) | The spatial reference of the extent. | SpatialReference |
upperLeft (Read Only) | The upper left property: A point object is returned. | Point |
upperRight (Read Only) | The upper right property: A point object is returned. | Point |
width (Read Only) | The extent width value. | Double |
Method Overview
Method | Explanation |
contains (second_geometry, {relation}) | Indicates if the base geometry contains the comparison geometry. contains is the opposite of within. Only True relationships are shown in this illustration. |
crosses (second_geometry) | Indicates if the two geometries intersect in a geometry of a lesser shape type. Two polylines cross if they share only points in common, at least one of which is not an endpoint. A polyline and an polygon cross if they share a polyline or a point (for vertical line) in common on the interior of the polygon which is not equivalent to the entire polyline. Only True relationships are shown in this illustration. |
disjoint (second_geometry) | Indicates if the base and comparison geometries share no points in common. Two geometries intersect if disjoint returns False. Only True relationships are shown in this illustration. |
equals (second_geometry) | Indicates if the base and comparison geometries are of the same shape type and define the same set of points in the plane. This is a 2D comparison only; M and Z values are ignored. Only True relationships are shown in this illustration. |
overlaps (second_geometry) | Indicates if the intersection of the two geometries has the same shape type as one of the input geometries and is not equivalent to either of the input geometries. Only True relationships are shown in this illustration. |
projectAs (spatial_reference, {transformation_name}) | Projects a geometry and optionally applies a geotransformation. To project, the geometry must have a spatial reference, and not have an unknown coordinate system. The new spatial reference system passed to the method defines the output coordinate system. If either spatial reference is unknown, the coordinates will not be changed. The z- and m-values are not changed by the projectAs method. |
touches (second_geometry) | Indicates if the boundaries of the geometries intersect. Two geometries touch when the intersection of the geometries is not empty, but the intersection of their interiors is empty. For example, a point touches a polyline only if the point is coincident with one of the polyline end points. Only True relationships are shown in this illustration. |
within (second_geometry, {relation}) | Indicates if the base geometry is within the comparison geometry. within is the opposite operator of contains. Only True relationships are shown in this illustration. The base geometry is within the comparison geometry if the base geometry is the intersection of the geometries and the intersection of their interiors is not empty. within is a Clementini operator, except in the case of an empty base geometry. |
Methods
contains (second_geometry, {relation})
Parameter | Explanation | Data Type |
second_geometry | A second geometry. | Object |
relation | The spatial relationship type.
(The default value is None) | String |
Data Type | Explanation |
Boolean |
A return Boolean value of True indicates this geometry contains the second geometry. |
crosses (second_geometry)
Parameter | Explanation | Data Type |
second_geometry | A second geometry. | Object |
Data Type | Explanation |
Boolean | A return Boolean value of True indicates the two geometries intersect in a geometry of a lesser shape type. |
disjoint (second_geometry)
Parameter | Explanation | Data Type |
second_geometry | A second geometry. | Object |
Data Type | Explanation |
Boolean | A return Boolean value of True indicates that the two geometries share no points in common. |
equals (second_geometry)
Parameter | Explanation | Data Type |
second_geometry | A second geometry. | Object |
Data Type | Explanation |
Boolean |
A return Boolean value of True indicates that the two geometries are of the same shape type and define the same set of points in the plane. |
overlaps (second_geometry)
Parameter | Explanation | Data Type |
second_geometry | A second geometry. | Object |
Data Type | Explanation |
Boolean | A return Boolean value of True indicates the intersection of the two geometries has the same dimension as one of the input geometries. |
projectAs (spatial_reference, {transformation_name})
Parameter | Explanation | Data Type |
spatial_reference | The new spatial reference. This can be a SpatialReference object or the coordinate system name. | SpatialReference |
transformation_name | The geotransformation name. | String |
Data Type | Explanation |
Object | The projected geometry. |
touches (second_geometry)
Parameter | Explanation | Data Type |
second_geometry | A second geometry. | Object |
Data Type | Explanation |
Boolean | A return Boolean value of True indicates the boundaries of the geometries intersect. |
within (second_geometry, {relation})
Parameter | Explanation | Data Type |
second_geometry | A second geometry. | Object |
relation | The spatial relationship type.
(The default value is None) | String |
Data Type | Explanation |
Boolean | A return Boolean value of True indicates this geometry is contained within the second geometry. |
Code sample
Display extent object properties for features.
import arcpy
feature_class = 'c:/Data/Florida.gdb/airports'
# Fetch each feature from the cursor and examine the extent properties
for row in arcpy.da.SearchCursor(feature_class, ['SHAPE@', 'CNTY_NAME']):
extent = row[0].extent
print('Extent of county {}:'.format(row[1]))
print('XMin: {}, YMin: {}'.format(extent.XMin, extent.YMin))
print('XMax: {}, YMax: {}'.format(extent.XMax, extent.YMax))