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:
Constructors
-
new Association(properties)
-
Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
String | more details The type of association. | more details | Association | |
String | more details The name of the class. | more details | Accessor | |
Number | more details | more details | Association | |
String | more details | more details | Association | |
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 | |
Boolean | more details | more details | Association | |
Polyline | more details The synthesized polyline geometry created between the two network elements. | more details | Association | |
Number | more details | more details | Association | |
Number | more details | 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
orcontainment
. There are also non-spatial associations that were introduced in schema version 4. Those will be added post 4.20Possible Values:"attachment"|"connectivity"|"containment"
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
errorCode Number
-
-
errorMessage String
-
-
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.
-
isContentVisible Boolean
-
-
percentAlong Number
-
-
status Number
-
-
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 | |
more details Adds one or more handles which are to be tied to the lifecycle of the object. | more details | Accessor | ||
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 ObjectA 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.
-
own(handleOrHandles)inheritedSince: ArcGIS API for JavaScript 4.24
-
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.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }); handle.remove(); // Assign a handle using own() this.own(reactiveUtils.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }));
Parameter:handleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
-
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.