Association

Association

AMD: require(["esri/rest/networks/support/Association"], (Association) => { /* code goes here */ });

ESM: import Association from "@arcgis/core/rest/networks/support/Association";

Class: esri/rest/networks/support/Association

Inheritance: Association Accessor

Since: ArcGIS API for JavaScript 4.20

The utility network associations model connectivity, containment and structure relations between assets. An Association connects two network elements, the "From" and "To", and order of the association matter. This class defines an association and its basic properties.

See also:

trace

Constructors

new Association(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

Type	Summary	Class
String	more details The type of association.	more details	Association
String	more details The name of the class.	more details	Accessor
NetworkElement	more details The from side network element of the association.	more details	Association
String	more details The globalId (UUID) of the association record, uniquely identifes this association row.	more details	Association
Polyline	more details The synthesized polyline geometry created between the two network elements.	more details	Association
NetworkElement	more details The to side network element of the association.	more details	Association

Property Details

associationType String

The type of association. Associations that could be synthesized are attachment, connectivity or containment. There are also non-spatial associations that were introduced in schema version 4. Those will be added post 4.20

Possible Values:"attachment"|"connectivity"|"containment"

declaredClass Stringreadonly inherited

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

fromNetworkElement NetworkElement

The from side network element of the association. Contains the globalid, network source, and terminal.

globalId String

The globalId (UUID) of the association record, uniquely identifes this association row.

line Polyline

The synthesized polyline geometry created between the two network elements.

toNetworkElement NetworkElement

The to side network element of the association. Contains the globalid, network source, and terminal.

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 details	Association
	Object	more details Converts an instance of this class to its ArcGIS portal JSON representation.	more details	Association

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.

ArcGIS API for JavaScriptAPI Reference

Was this page helpful?

Was this page helpful?