QueryCircuitsParameters | References | ArcGIS Maps SDK for JavaScript

import QueryCircuitsParameters from "@arcgis/core/rest/networks/circuits/support/QueryCircuitsParameters.js";

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

Inheritance: QueryCircuitsParameters→Accessor

Since: ArcGIS Maps SDK for JavaScript 5.0

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	QueryCircuitsParametersProperties

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
circuitHierarchy	CircuitHierarchy
circuitStatus	CircuitStatus \| null \| undefined
declaredClass readonly inherited	string	Accessor
locations	CircuitLocation[] \| null \| undefined
locationType	"start" \| "stop" \| "all" \| null \| undefined

circuitHierarchy

Property

Type: CircuitHierarchy

Since: ArcGIS Maps SDK for JavaScript 5.1

Specifies whether to return the associated consumer and provider circuits with the queried circuit.

Default value: "none"

circuitStatus

Property

Type: CircuitStatus | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.1

Specifies whether to filter the result of the query to return only circuits of a certain status.

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.

locations

autocast Property

Type: CircuitLocation[] | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.1

The list of locations to query circuits by.

locationType

Property

Type: "start" | "stop" | "all" | null | undefined

The type of location to query circuits by.

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.