Indicates the specific units of measurement of an instance of LinearUnit, or linear measurement operation. More...
| Import Statement: | import Esri.ArcGISRuntime 100.15 |
| Since: | Esri.ArcGISRuntime 100.0 |
| Inherits: |
Properties
- initAreaUnit : AreaUnit
- linearUnitId : LinearUnitId
Signals
Methods
- double convertFrom(LinearUnit fromUnit, double length)
- double convertFromMeters(double meters)
- double convertTo(LinearUnit toUnit, double length)
- double convertToMeters(double unitValue)
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.
- 1: linearUnitId (Enums.LinearUnitId), or
- 2: initAreaUnit (AreaUnit) (Since Esri.ArcGISRuntime 100.6)
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.
The Enums.LinearUnitId corresponding to this LinearUnit.
Signal Documentation
Emitted when initAreaUnit property changes.
Note: This signal will only be emitted when the property initializes during the instantiation of the component.
Note: The corresponding handler is onInitAreaUnitChanged.
This signal was introduced in Esri.ArcGISRuntime 100.6.
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(LinearUnit fromUnit, double length) |
Returns an length value converted from another LinearUnit (fromUnit) to this LinearUnit.
Returns an length meters converted from meters to this LinearUnit.
double convertTo(LinearUnit toUnit, double length) |
Returns an length expressed in this LinearUnit to another LinearUnit, toUnit.
Returns an length value unitValue converted from this LinearUnit to meters.