A linear unit input or output parameter. More...
Import Statement: | import Esri.ArcGISRuntime 100.15 |
Since: | Esri.ArcGISRuntime 100.0 |
Inherits: |
Properties
- distance : double
- linearUnit : LinearUnit
- unit : Enums.GeoprocessingLinearUnits
Signals
Detailed Description
Geoprocessing tasks support a set of linear units defined in the Enums.GeoprocessingLinearUnits enumeration.
When a GeoprocessingLinearUnit parameter is created with one of the supported Enums.GeoprocessingLinearUnits, the value is sent to the service using the defined linear unit type.
When a GeoprocessingLinearUnit object is created with a LinearUnit, the value is converted to meters if the type is not supported. For example if provided LinearUnit is international miles, the value is converted to meters since only the US Survey Miles unit is supported in geoprocessing. After the GeoprocessingLinearUnit object is created, the used linear unit type can be checked from the unit property.
When a GeoprocessingLinearUnit object is created with a supported LinearUnit, then no conversion takes place and the value is sent to the service using the defined type.
When GeoprocessingLinearUnit is returned as an output parameter, you can get LinearUnit using the linearUnit property.
This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.
Type | Default Property |
---|---|
LinearUnit | linearUnit |
Property Documentation
[default] linearUnit : LinearUnit |
The LinearUnit associated with the distance value.
The distance value's units.
See also Enums.GeoprocessingLinearUnits.
Signal Documentation
The signal emitted when the distance property changes.
Note: The corresponding handler is onDistanceChanged
.
The signal emitted when the linearUnit property changes.
Note: The corresponding handler is onLinearUnitChanged
.
The signal emitted when the unit property changes.
Note: The corresponding handler is onUnitChanged
.