Skip To Content ArcGIS for Developers Sign In Dashboard

LinearUnit QML Type

Indicates the specific units of measurement of an instance of LinearUnit, or linear measurement operation. More...

Import Statement: import Esri.ArcGISRuntime 100.9
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.

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

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

Property Documentation

initAreaUnit : AreaUnit

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

This property was introduced in Esri.ArcGISRuntime 100.6.


linearUnitId : LinearUnitId

The Enums.LinearUnitId corresponding to this LinearUnit.


Signal Documentation

areaUnitIdChanged()

Emitted when AreaUnit::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.6.


linearUnitIdChanged()

Emitted when the linearUnitId property changes.

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

Note: The corresponding handler is onLinearUnitIdChanged.

This signal was introduced in Esri.ArcGISRuntime 100.4.


Method Documentation

double convertFrom(fromUnit, double length)

Returns an length value converted from another LinearUnit (fromUnit) to this LinearUnit.


double convertFromMeters(meters)

Returns an length meters converted from meters to this LinearUnit.


double convertTo(toUnit, double length)

Returns an length expressed in this LinearUnit to another LinearUnit, toUnit.


double convertToMeters(unitValue)

Returns an length value unitValue converted from this LinearUnit to meters.



Feedback on this topic?