LinearUnit
require(["esri/tasks/support/LinearUnit"], function(LinearUnit) { /* code goes here */ });esri/tasks/support/LinearUnitA data object containing a linear distance.
Constructors
- new LinearUnit(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| String | The name of the class. more details | more details | Accessor | |
| Number | Specifies the value of the linear distance. more details | more details | LinearUnit | |
| String | Specifies the unit type of the linear distance. more details | more details | LinearUnit |
Property Details
- Since: ArcGIS API for JavaScript 4.7
The name of the class. The declared class name is formatted as
esri.folder.className.
- distance Number
Specifies the value of the linear distance.
- Default Value:0
- units String
Specifies the unit type of the linear distance.
Possible Values:"feet"|"kilometers"|"meters"|"miles"|"nautical-miles"|"yards"
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. more details | more details | LinearUnit | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | LinearUnit |
Method Details
- fromJSON(json){*}static
Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input
jsonparameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.Parameter:json ObjectA JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.
Returns:Type Description * Returns a new instance of this class.
- toJSON(){Object}
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() topic in the Guide for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.