LinearUnit

require(["esri/tasks/support/LinearUnit"], function(LinearUnit) { /* code goes here */ });

Class: esri/tasks/support/LinearUnit

Inheritance: LinearUnit Accessor

Since: ArcGIS API for JavaScript 4.0

A data object containing a linear distance.

Constructors

new LinearUnit(properties)

Parameter:

properties Object

optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.

Show inherited properties Hide inherited properties

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

declaredClassStringreadonly inherited Since: ArcGIS API for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

distanceNumber

Specifies the value of the linear distance.

Default Value:0

unitsString

Specifies the unit type of the linear distance.

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 json parameter 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 Object

A 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.