Packagecom.esri.aws.awx.geom
Classpublic class Extent
Implementscom.esri.aws.awx.rtree.IExtentObject

The bounding box (maxX, maxY, minX, minY) of a geometry. For example, a PointShape, PolygonShape, PolylineShape, RubberBandEvent, etc.



Public Properties
 PropertyDefined by
  maxX : Number
The maximum x-coordinate of the extent.
Extent
  maxY : Number
The maximum y-coordinate of the extent.
Extent
  minX : Number
The minimum x-coordinate of the extent.
Extent
  minY : Number
The minimum y-coordinate of the extent.
Extent
Public Methods
 MethodDefined by
  
Returns a cloned instance of this extent.
Extent
  
contains(x:Number, y:Number):Boolean
Indicates whether a point is within the extent.
Extent
  
containsExtent(env:Extent):Boolean
Indicates whether this extent contains another extent.
Extent
  
containsPoint(pt:GeoPoint):Boolean
Indicates whether the extent contains the given point.
Extent
  
createBuffer(percent:Number):Extent
Creates an extent that is percent larger.
Extent
  
[static] Creates an empty extent, where minX > maxX and minY > maxY.
Extent
  
createExtentByGeoPoints(geoPoints:Array):Extent
[static] Creates an extent by specifying an array of coordinates and is merely included because there's no method overloading in Flex.
Extent
  
createExtentMinMax(xmin:Number, ymin:Number, xmax:Number, ymax:Number):Extent
[static] Creates an extent by specifying min/max x/y.
Extent
  
disjointExtent(env:Extent):Boolean
Indicates whether this extent is disjointed from another extent (no intersection).
Extent
  
equalsExtent(extent:Extent):Boolean
Indicates that a given extent is exactly equal to this extent.
Extent
  
isEmpty():Boolean
Returns true if minX > maxX and minY > maxY (which indicates an empty extent), false otherwise.
Extent
  
union(x:Number, y:Number):void
Adds a point to the extent.
Extent
  
unionExtent(env:Extent):void
Performs a union operation with another extent and changes 'this' extent.
Extent
  
Adds a point to the extent.
Extent
Property detail
maxXproperty
public var maxX:Number

The maximum x-coordinate of the extent.

maxYproperty 
public var maxY:Number

The maximum y-coordinate of the extent.

minXproperty 
public var minX:Number

The minimum x-coordinate of the extent.

minYproperty 
public var minY:Number

The minimum y-coordinate of the extent.

Method detail
clone()method
public function clone():Extent

Returns a cloned instance of this extent.

Returns
Extent — cloned instance of this extent.
contains()method 
public function contains(x:Number, y:Number):Boolean

Indicates whether a point is within the extent.

Parameters
x:Number — the latitude of the point
 
y:Number — the longitude of the point

Returns
Boolean
containsExtent()method 
public function containsExtent(env:Extent):Boolean

Indicates whether this extent contains another extent.

Parameters
env:Extent — other extent.

Returns
Boolean — True if this extent contains the passed extent.
containsPoint()method 
public function containsPoint(pt:GeoPoint):Boolean

Indicates whether the extent contains the given point.

Parameters
pt:GeoPoint — the point

Returns
Boolean
createBuffer()method 
public function createBuffer(percent:Number):Extent

Creates an extent that is percent larger.

Parameters
percent:Number — the percentage amount by (0-1) which to buffer the extent.

Returns
Extent — The buffered extent.
createEmptyExtent()method 
public static function createEmptyExtent():Extent

Creates an empty extent, where minX > maxX and minY > maxY.

Returns
Extent — A new Extent that's initially empty.
createExtentByGeoPoints()method 
public static function createExtentByGeoPoints(geoPoints:Array):Extent

Creates an extent by specifying an array of coordinates and is merely included because there's no method overloading in Flex.

Parameters
geoPoints:Array — an array of GeoPoints.

Returns
Extent — A new extent that conceptually contains the passed geoPoints.
createExtentMinMax()method 
public static function createExtentMinMax(xmin:Number, ymin:Number, xmax:Number, ymax:Number):Extent

Creates an extent by specifying min/max x/y.

Parameters
xmin:Number — Minimum x.
 
ymin:Number — Minimum y.
 
xmax:Number — Maximum x.
 
ymax:Number — Maximum y.

Returns
Extent — The new extent.
disjointExtent()method 
public function disjointExtent(env:Extent):Boolean

Indicates whether this extent is disjointed from another extent (no intersection).

Parameters
env:Extent — other extent.

Returns
Boolean — True if disjointed else false.
equalsExtent()method 
public function equalsExtent(extent:Extent):Boolean

Indicates that a given extent is exactly equal to this extent. All comparisons are absolute not relative.

Parameters
extent:Extent

Returns
Boolean — True if equal, else false.
isEmpty()method 
public function isEmpty():Boolean

Returns true if minX > maxX and minY > maxY (which indicates an empty extent), false otherwise.

Returns
Boolean
union()method 
public function union(x:Number, y:Number):void

Adds a point to the extent. THIS ASSUMES YOU HAVE AN EXISTING VALID EXTENT. To use this, construct the extent with the first point and union() all the other points.

Parameters
x:Number — the latitude of the point
 
y:Number — the longitude of the point
unionExtent()method 
public function unionExtent(env:Extent):void

Performs a union operation with another extent and changes 'this' extent.

Parameters
env:Extent — the extent (the other extent)
unionPoint()method 
public function unionPoint(pt:GeoPoint):void

Adds a point to the extent. THIS ASSUMES YOU HAVE AN EXISTING VALID EXTENT. To use this, construct the extent with the first point and union() all the other points.

Parameters
pt:GeoPoint — the point