Class Envelope
Represents an axis-aligned envelope.
Namespace: Esri.ArcGISRuntime.Geometry
Assembly: Esri.ArcGISRuntime.dll
Syntax
[TypeConverter(typeof(EnvelopeConverter))]
public class Envelope : GeometryRemarks
An envelope is defined by a pair of x,y coordinates representing the lower-left and upper-right vertices of a rectangular bounding-box. The vertices may optionally contain z coordinates and/or m (measure) values. An envelope is associated with a SpatialReference which specifies the coordinate system.
An envelope is typically used to represent the minimum bounding rectangle for a Geometry or to define a simple area of interest such as a Map's extent. Ordinarily, an envelope is a rectangle whose sides are oriented parallel to the x and y axes. These characteristics allow for simpler construction and manipulation of this object than is possible with a polygon.
An envelope may optionally have a Depth, in which case its geometry is that of a rectangular cuboid.
Envelopes are based upon the parent Geometry Class. The Geometry Class is immutable which means that you can not change its shape once it is created. If you need to modify an Envelope once it has been created, use the EnvelopeBuilder Class instead. The ToGeometry() Method will provide you with the Envelope object.
EnvelopeBuilderConstructors
| Name | Description |
|---|---|
| Envelope(MapPoint, MapPoint) | Initializes a new instance of the Envelope class from given diagonal corner points. |
| Envelope(MapPoint, Double, Double) | Initializes a new instance of the Envelope class from a center point, with a defined width and height. |
| Envelope(MapPoint, Double, Double, Double) | Initializes a new instance of the Envelope class from a center point, with a defined width, height, and depth. |
| Envelope(Double, Double, Double, Double) | Initializes a new instance of the Envelope class from given diagonal corner coordinates. |
| Envelope(Double, Double, Double, Double, SpatialReference) | Initializes a new instance of the Envelope class from given diagonal corner coordinates in the given SpatialReference. |
| Envelope(Double, Double, Double, Double, Double, Double) | Initializes a new instance of the Envelope class based on the x, y, and z values. |
| Envelope(Double, Double, Double, Double, Double, Double, SpatialReference) | Initializes a new instance of the Envelope class based on the x, y, and z values in the given SpatialReference. |
Properties
| Name | Description |
|---|---|
| Depth | Gets the depth (ZMax - ZMin) for this envelope. |
| Dimension | Gets a number that describes the dimensionality of a geometry. |
| Extent | Gets the extent of this Envelope, which is the same as the Envelope itself. |
| GeometryType | Gets the geometry type (always Envelope). |
| HasM | Gets a value indicating whether this Envelope has M (measure) values. |
| HasZ | Gets a value indicating whether this Envelope has Z-values. |
| Height | Gets the height of the Envelope (along Y-axis). |
| IsEmpty | Gets a value indicating whether or not this Envelope is empty. |
| MMax | Gets maximum M (measure) value. |
| MMin | Gets minimum M (measure) value. |
| Width | Gets the width of this Envelope (along X-axis). |
| XMax | Gets the max coordinate along X-axis (upper right corner). |
| XMin | Gets the min coordinate along X-axis (lower left corner). |
| YMax | Gets the max coordinate along Y-axis (upper right corner). |
| YMin | Gets the min coordinate along Y-axis (lower left corner). |
| ZMax | Gets the max coordinate along Z-axis. |
| ZMin | Gets the min coordinate along Z-axis. |
Methods
| Name | Description |
|---|---|
| CreateWithM(Double, Double, Double, Double, Double, Double) | Creates an Envelope based on the given x, y, and m values. |
| CreateWithM(Double, Double, Double, Double, Double, Double, SpatialReference) | Creates an Envelope based on the given x, y, and m values in the given SpatialReference. |
| CreateWithM(Double, Double, Double, Double, Double, Double, Double, Double) | Creates an Envelope based on the given x, y, z, and m values. |
| CreateWithM(Double, Double, Double, Double, Double, Double, Double, Double, SpatialReference) | Creates an envelope based on the x, y, z and m values in the given SpatialReference. |
| GetCenter() | Gets the center of the Envelope. |
| IsEqual(Geometry) | Compares two geometries for equality. |
| ToString() | Returns a System.String that represents the current System.Object. |
Extension Methods
Applies to
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 200.5 |
| .NET | 100.13 - 200.5 |
| .NET Windows | 100.13 - 200.5 |
| .NET Android | 200.0 - 200.5 |
| .NET iOS | 200.0 - 200.5 |
| .NET Framework | 100.0 - 200.5 |
| Xamarin.Android | 100.0 - 100.15 |
| Xamarin.iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.5 |