VerifyCircuitsParameters | References | ArcGIS Maps SDK for JavaScript

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

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

Inheritance: VerifyCircuitsParameters→Accessor

Since: ArcGIS Maps SDK for JavaScript 5.0

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	VerifyCircuitsParametersProperties

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
circuitNames	string[]
declaredClass readonly inherited	string	Accessor
forceVerify	boolean
outSpatialReference	SpatialReference \| null \| undefined
synthesizeGeometries	boolean

circuitNames

Property

Type: string[]

The names of the circuit or circuits to be verified.

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.

forceVerify

Property

Type: boolean

Enables circuits to be verified regardless of their status. When false, the verify operation returns an error if the circuit status is clean. When true, the verify operation will run against clean, dirty, and invalid circuits. The default is false.

Default value: false

outSpatialReference

autocast Property

Type: SpatialReference | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.1

The spatial reference of the returned geometry. If not specified, the geometry is returned in the spatial reference of the feature service.

synthesizeGeometries

Property

Type: boolean

Specifies whether geometries will be inferred and created (synthesized) for the circuits. The default is false.

Default value: false

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.