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 | | |
Properties
| Property | Type | Class |
|---|---|---|
declaredClass readonly inherited | ||
| | ||
| | ||
| |
location
- Type
- CircuitLocation | null | undefined
The start or stop location of the circuit to query.
returnConsumerCircuits
- Type
- boolean
If false, returns only the immediate circuits passing through the specified location. Otherwise, returns all the circuits that consume the immediate circuits.
- Default value
- false
Methods
fromJSON
- Signature
-
fromJSON (json: any): any
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 | 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
- Signature
-
toJSON (): any
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.