Envelope class final
A geometry that represents a rectangular shape.
An Envelope is an axis-aligned box described by the coordinates of the lower left corner and the coordinates of the upper right corner. They are commonly used to represent the spatial extent covered by layers or other geometries, or to define an area of interest. They can be used as the geometry for a graphic and as an input for many spatial operations. Although they both represent a geographic area, an Envelope is distinct from a Polygon, and they cannot always be used interchangeably.
New instances of Envelope are defined by specifying a minimum and maximum x-coordinate and minimum and maximum y-coordinate, and a SpatialReference. Optionally, a minimum and maximum z-value can be specified to define the depth of the envelope.
Constructors
- Envelope.fromCenter(ArcGISPoint center, {required double width, required double height, double? depth})
-
Creates an envelope from a center point and a width, height, and depth.
factory
- Envelope.fromPoints(ArcGISPoint a, ArcGISPoint b)
-
Creates an envelope from any two points.
factory
- Envelope.fromXY({required double xMin, required double yMin, required double xMax, required double yMax, SpatialReference? spatialReference})
-
Creates an envelope based on the x,y coordinates with a spatial reference.
factory
- Envelope.fromXYM({required double xMin, required double yMin, required double xMax, required double yMax, required double mMin, required double mMax, SpatialReference? spatialReference})
-
Creates an envelope based on the x, y and m values with a spatial
reference.
factory
- Envelope.fromXYZ({required double xMin, required double yMin, required double xMax, required double yMax, required double zMin, required double zMax, SpatialReference? spatialReference})
-
Creates an envelope based on x, y, and z values with the spatial
reference.
factory
- Envelope.fromXYZM({required double xMin, required double yMin, required double xMax, required double yMax, required double zMin, required double zMax, required double mMin, required double mMax, SpatialReference? spatialReference})
-
Creates an envelope based on the x, y, z and m values with a spatial
reference.
factory
Properties
- center → ArcGISPoint
-
The center point for the envelope.
no setter
- depth → double
-
The depth (ZMax - ZMin) for the envelope.
no setter
- dimension → GeometryDimension
-
Indicates the dimensionality of a Geometry, relating to the number of
spatial dimensions in which the geometry may have a size.
no setterinherited
- extent → Envelope
-
The minimum enclosing bounding-box (or Envelope) that covers the
geometry.
no setterinherited
- geometryType → GeometryType
-
This indicates the type of geometrical shape it can represent, such as Envelope, Point or Polygon.
no setterinherited
- hasCurves → bool
-
True if this geometry contains curve segments, false otherwise.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasM → bool
-
True if the geometry has m values (measure values), false otherwise.
no setterinherited
- hasZ → bool
-
True if the geometry has z-coordinate values, false otherwise.
no setterinherited
- height → double
-
The height for the envelope.
no setter
- isEmpty → bool
-
True if the geometry is empty, false otherwise.
no setterinherited
- mMax → double?
-
The m maximum value for the envelope.
no setter
- mMin → double?
-
The m minimum value for the envelope.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- spatialReference → SpatialReference?
-
The spatial reference for this geometry.
no setterinherited
- width → double
-
The width for the envelope.
no setter
- xMax → double
-
The x maximum value for the envelope.
no setter
- xMin → double
-
The x minimum value for the envelope.
no setter
- yMax → double
-
The y maximum value for the envelope.
no setter
- yMin → double
-
The y minimum value for the envelope.
no setter
- zMax → double?
-
The z maximum value for the envelope.
no setter
- zMin → double?
-
The z minimum value for the envelope.
no setter
Methods
-
equalsWithTolerance(
{required Geometry right, required double tolerance}) → bool -
Checks if two geometries are approximately the same within the given
tolerance.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
Returns a JSON representation of this Object in the data type used by jsonDecode.
inherited
-
toJsonString(
) → String -
Returns a JSON representation of this Object as a String.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited