Envelope QML Type

  • Esri.ArcGISRuntime
  • Envelope
  • Represents a rectangular area, defined by a minimum and maximum x coordinate and a minimum and maximum y coordinate, and a spatial reference. More...

    Import Statement: import Esri.ArcGISRuntime
    Since: Esri.ArcGISRuntime 100.0
    Inherits:

    Geometry

    Properties

    Signals

    Detailed Description

    An Envelope is an axis-aligned box described by the coordinates of the lower left corner and the coordinates of the upper right corner. Envelopes can optionally have minimum and maximum z (height) and m (measure) attributes.

    The sides of an Envelope align with the axes of its spatial reference. If the spatial reference is a geographic coordinate system, the x-coordinates relate to longitude and the y-coordinates relate to latitude.

    Envelopes 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 an Envelope and a Polygon both represent a geographic area, they are distinct and cannot always be used interchangeably. An Envelope cannot be used as the Geometry for a feature.

    Envelope is immutable. Instead of changing the properties of an existing Envelope, create a new Envelope instance, or use EnvelopeBuilder.

    See also JsonSerializable.

    Property Documentation

    [read-only] center : Point

    Returns the center point of the Envelope (read-only).


    [read-only, since Esri.ArcGISRuntime 100.1] depth : double

    Returns the depth (zMax - zMin) of the Envelope (read-only).

    A 2D envelope has zero depth.

    This property was introduced in Esri.ArcGISRuntime 100.1.


    [read-only] height : double

    Returns the height of the Envelope (read-only).


    mMax : double

    The m max property.


    mMin : double

    The m min property.


    [read-only] width : double

    Returns the width of the Envelope (read-only).


    xMax : double

    The x max property.


    xMin : double

    The x min property.


    yMax : double

    The y max property.


    yMin : double

    The y min property.


    zMax : double

    The z max property.


    zMin : double

    The z min property.


    Signal Documentation

    [since Esri.ArcGISRuntime 100.4] centerChanged()

    Emitted when the center property changes.

    Note: This signal will only be emitted when the property initializes during the instantiation of the component.

    Note: The corresponding handler is onCenterChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.4.


    [since Esri.ArcGISRuntime 100.4] depthChanged()

    Emitted when the depth property changes.

    Note: This signal will only be emitted when the property initializes during the instantiation of the component.

    Note: The corresponding handler is onDepthChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.4.


    [since Esri.ArcGISRuntime 100.4] heightChanged()

    Emitted when the height property changes.

    Note: This signal will only be emitted when the property initializes during the instantiation of the component.

    Note: The corresponding handler is onHeightChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.4.


    [since Esri.ArcGISRuntime 100.4] mMaxChanged()

    Emitted when the mMax property changes.

    Note: This signal will only be emitted when the property initializes during the instantiation of the component.

    Note: The corresponding handler is onMMaxChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.4.


    [since Esri.ArcGISRuntime 100.4] mMinChanged()

    Emitted when the mMin property changes.

    Note: This signal will only be emitted when the property initializes during the instantiation of the component.

    Note: The corresponding handler is onMMinChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.4.


    [since Esri.ArcGISRuntime 100.4] widthChanged()

    Emitted when the width property changes.

    Note: This signal will only be emitted when the property initializes during the instantiation of the component.

    Note: The corresponding handler is onWidthChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.4.


    [since Esri.ArcGISRuntime 100.4] xMaxChanged()

    Emitted when the xMax property changes.

    Note: This signal will only be emitted when the property initializes during the instantiation of the component.

    Note: The corresponding handler is onXMaxChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.4.


    [since Esri.ArcGISRuntime 100.4] xMinChanged()

    Emitted when the xMin property changes.

    Note: This signal will only be emitted when the property initializes during the instantiation of the component.

    Note: The corresponding handler is onXMinChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.4.


    [since Esri.ArcGISRuntime 100.4] yMaxChanged()

    Emitted when the yMax property changes.

    Note: This signal will only be emitted when the property initializes during the instantiation of the component.

    Note: The corresponding handler is onYMaxChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.4.


    [since Esri.ArcGISRuntime 100.4] yMinChanged()

    Emitted when the yMin property changes.

    Note: This signal will only be emitted when the property initializes during the instantiation of the component.

    Note: The corresponding handler is onYMinChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.4.


    [since Esri.ArcGISRuntime 100.4] zMaxChanged()

    Emitted when the zMax property changes.

    Note: This signal will only be emitted when the property initializes during the instantiation of the component.

    Note: The corresponding handler is onZMaxChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.4.


    [since Esri.ArcGISRuntime 100.4] zMinChanged()

    Emitted when the zMin property changes.

    Note: This signal will only be emitted when the property initializes during the instantiation of the component.

    Note: The corresponding handler is onZMinChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.4.


    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.