TerminalConfiguration

AMD: require(["esri/networks/support/TerminalConfiguration"], (TerminalConfiguration) => { /* code goes here */ });
ESM: import TerminalConfiguration from "@arcgis/core/networks/support/TerminalConfiguration";
Class: esri/networks/support/TerminalConfiguration
Inheritance: TerminalConfiguration Accessor
Since: ArcGIS API for JavaScript 4.20

A device feature can be assigned a terminal configuration which could have one or more terminals. The terminal configuration defines the terminals and the permissable paths between them. For example, a device feature could have a Dual Terminal configuration which has a High and a Low terminal. A downstream trace starting from High side terminal will return the Low side terminal however the same trace starting from the Low side terminal won't return the High side terminal.

Another example, a tranformer with tri-state terminal configuration (3 terminals) H, X1, X2. The allowed paths are H->X1 and H->X2 with a default path H->X1. Running a downstream trace from the H terminal will select X1 and anything underneath it but not X2. The device path can be altered with the terminalConfiguration field.

     H

   /   \

X1       X2

The terminal class defines terminal properties.

See also:

Constructors

new TerminalConfiguration(properties)
Parameter:
properties Object
optional

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

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

The default terminal configuration path defined.

more detailsTerminalConfiguration
Numbermore details

A unique numeric identifer of the terminal configuration.

more detailsTerminalConfiguration
Stringmore details

The name of the terminal configuration.

more detailsTerminalConfiguration
Terminal[]more details

An array of terminals defined in this configuration.

more detailsTerminalConfiguration
Stringmore details

Terminal configurations can be defined as directional or bidirectional.

more detailsTerminalConfiguration

Property Details

declaredClass Stringreadonly inherited

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

defaultConfiguration String

The default terminal configuration path defined.

id Number

A unique numeric identifer of the terminal configuration.

name String

The name of the terminal configuration.

terminals Terminal[]

An array of terminals defined in this configuration.

traversabilityModel String

Terminal configurations can be defined as directional or bidirectional. In a directional traversability model, one or more terminals can be defined as upstream where the flow of commedity enters or leaves.

Possible Values:"directional"|"bidirectional"

Default Value:null

Method Overview

Name Return Type Summary Class
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsTerminalConfiguration
Objectmore details

Converts an instance of this class to its ArcGIS portal JSON representation.

more detailsTerminalConfiguration

Method Details

fromJSON(json){*}static

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.

Parameter:
json Object

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:
Type Description
* Returns a new instance of this class.
toJSON(){Object}

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

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.