AreaUnit QML Type

  • Esri.ArcGISRuntime
  • AreaUnit
  • Indicates the units of measurement of an instance of AreaUnit, or area measurement operation. More...

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

    Unit

    Properties

    Signals

    Methods

    Detailed Description

    Instances of types that inherit from the Units type, like this one does, are initialized as a specific unit of measurement. Each instance has properties for the unit name (singular, plural and abbreviated) and provides methods for unit conversion.

    AreaUnit may be created two possible ways, which are mutually exclusive. In the event both properties are assigned, the first one will take precedence.

    When instantiated from a LinearUnit, the corresponding AreaUnit will be created. I.e Meters will become square meters.

    Property Documentation

    areaUnitId : Enums.AreaUnitId

    The Enums.AreaUnitId corresponding to this AreaUnit.


    [since Esri.ArcGISRuntime 100.6] initLinearUnit : LinearUnit

    The LinearUnit that corresponds to the desired AreaUnit. E.g. Meters would cause this unit to be created as square meters.

    This property was introduced in Esri.ArcGISRuntime 100.6.


    Signal Documentation

    [since Esri.ArcGISRuntime 100.4] areaUnitIdChanged()

    Emitted when the areaUnitId property changes.

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

    Note: The corresponding handler is onAreaUnitIdChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.4.


    [since Esri.ArcGISRuntime 100.6] initLinearUnitChanged()

    Emitted when the initLinearUnit property changes.

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

    Note: The corresponding handler is onInitLinearUnitChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.6.


    Method Documentation

    double convertFrom(AreaUnit fromUnit, double area)

    Returns an area value converted from another AreaUnit (fromUnit) to this AreaUnit.


    double convertFromSquareMeters(double squareMeters)

    Returns an area squareMeters converted from square meters to this AreaUnit.


    double convertTo(AreaUnit toUnit, double area)

    Returns an area value converted from this AreaUnit to another AreaUnit (toUnit).


    double convertToSquareMeters(double unitValue)

    Returns an area unitValue converted from this AreaUnit to square meters.


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