NavigationConstraint | References | ArcGIS Maps SDK for JavaScript

import NavigationConstraint from "@arcgis/core/ground/NavigationConstraint.js";

const NavigationConstraint = await $arcgis.import("@arcgis/core/ground/NavigationConstraint.js");

Inheritance: NavigationConstraint→Accessor

Since: ArcGIS Maps SDK for JavaScript 5.0

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	NavigationConstraintProperties

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
type	"none" \| "stay-above"

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.

type

Property

Type: "none" | "stay-above"

The type of the constraint. It can be one of the following:

Value	Description
stay-above	User can only navigate above ground surface
none	User can navigate above and below the ground surface

Default value: stay-above

Default value: "none"

Methods

Method	Signature	Class
fromJSON inherited static	fromJSON(json: any): any	JSONSupportMixin
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.

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.