OutDistance | References | ArcGIS Maps SDK for JavaScript

import OutDistance from "@arcgis/core/rest/support/OutDistance.js";

const OutDistance = await $arcgis.import("@arcgis/core/rest/support/OutDistance.js");

Inheritance: OutDistance→Accessor

Since: ArcGIS Maps SDK for JavaScript 5.2

Defines the outDistance parameter on a Query and specifies whether to return the distance of each feature in the query result. It can also specify the order in which features are returned based on distance. Distance values are returned only when the outDistance is specified and its OutDistance.returnDistance property is true. The distance values are included in the Graphic.distance property of each feature.

Distance values are measured from referenceGeometry when specified; otherwise, they are measured from Query.geometry.

Known Limitations

Supported only on a service-backed FeatureLayer where the supportsOutDistance capability is true.

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	OutDistanceProperties

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

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
declaredClass readonly inherited	string	Accessor
order	"ascending" \| "descending" \| null \| undefined
outDistanceUnit	"feet" \| "miles" \| "nautical-miles" \| "us-nautical-miles" \| "meters" \| "kilometers" \| null \| undefined
referenceGeometry	GeometryWithoutMeshUnion \| null \| undefined
returnDistance	boolean \| null \| undefined

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

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

order

Property

Type: "ascending" | "descending" | null | undefined

Indicates whether to return features sorted by distance. The "ascending" option returns the nearest features first while the "descending" option returns farthest features first, and null indicates there should be no distance-based ordering.

outDistanceUnit

Property

Type: "feet" | "miles" | "nautical-miles" | "us-nautical-miles" | "meters" | "kilometers" | null | undefined

The distance unit used for the returned distance values. This property applies only when returnDistance is true. If omitted, the unit is determined from the Query.outSpatialReference. If no output spatial reference is specified, the service's spatial reference unit is used.

referenceGeometry

autocast Property

Type: GeometryWithoutMeshUnion | null | undefined

Geometry used as the reference for measuring distance. Distances are measured from each feature to this geometry. If not specified, distances are measured from the Query.geometry.

returnDistance

Property

Type: boolean | null | undefined

Indicates whether to return the calculated distance value for each feature in a distance query result. When graphics are queried, distance values are returned in each feature's distance property.

Methods

Method	Signature	Class
fromJSON inherited static	fromJSON(json: any): any	JSONSupportMixin
clone inherited	clone(): this	ClonableMixin
toJSON inherited	toJSON(): any	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. 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.

Parameters

Parameter	Type	Description	Required
json	any	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: any
Returns a new instance of this class.

clone

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns: this
A deep clone of the class instance that invoked this method.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.