TerminalConfiguration | API Reference | ArcGIS Maps SDK for JavaScript 4.31

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 transformer 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

TerminalConfiguration Constructor 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 Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The name of the class.	Accessor
String	The default terminal configuration path defined.	TerminalConfiguration
Number	A unique numeric identifier of the terminal configuration.	TerminalConfiguration
String	The name of the terminal configuration.	TerminalConfiguration
Terminal []	An array of terminals defined in this configuration.	TerminalConfiguration
String	Terminal configurations can be defined as directional or bidirectional.	TerminalConfiguration

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

defaultConfiguration Property defaultConfiguration String

The default terminal configuration path defined.

id Property id Number

A unique numeric identifier of the terminal configuration.

name Property name String

The name of the terminal configuration.

terminals Property terminals Terminal[]

An array of terminals defined in this configuration.

traversabilityModel Property 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 commodity enters or leaves.

Possible Values:"directional" |"bidirectional"

Default Value:null

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
*	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	TerminalConfiguration
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	TerminalConfiguration

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

fromJSON Method 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.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	Description
Boolean	Returns `true` if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toJSON Method 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.