Association | References | ArcGIS Maps SDK for JavaScript

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

Inheritance:: Association→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.25

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

Example

// Define the QueryAssociationsParameters
const queryAssociationsParameters = new QueryAssociationsParameters({
  types: ["containment", "attachment", "junction-edge-from-connectivity"],
  elements: [
    {
      networkSourceId: 2,
      globalId: "{46B3FA19-2237-4D38-A7CF-AA34C3T40420}",
      objectId: 44,
      terminalId: 1,
      assetGroupCode: 1,
      assetTypeCode: 1
    },
    {
      networkSourceId: 9,
      globalId: "{321C0089-1165-42D9-K45B-ED91B1A40500}",
      objectId: 45,
      terminalId: 1,
      assetGroupCode: 13,
      assetTypeCode: 441
    }
 ]
});

// Query associations, and assign the query result to a variable `associations`
const associations = await queryAssociations(networkServiceUrl, queryAssociationsParameters);

// Print out the first association
console.log(associations[0]);

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`AssociationProperties`

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
`associationType`	`AssociationType`
`declaredClass` readonly inherited	`string`	Accessor
`errorCode`	`number \| null \| undefined`
`errorMessage`	`string \| null \| undefined`
`fromNetworkElement`	`NetworkElement \| null \| undefined`
`geometry`	`Polyline`
`globalId`	`string \| null \| undefined`
`isContentVisible`	`boolean \| null \| undefined`
`percentAlong`	`number \| null \| undefined`
`status`	`number \| null \| undefined`
`toNetworkElement`	`NetworkElement \| null \| undefined`

associationType

Property

Type: AssociationType

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

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

errorCode

Property

Type: number | null | undefined

Error code returned from the server for a failed associations query.

errorMessage

Property

Type: string | null | undefined

Message returned from the server for a failed associations query.

fromNetworkElement

autocast Property

Type: NetworkElement | null | undefined

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

geometry

autocast Property

Type: Polyline

The synthesized Polyline geometry created between the two network elements.

globalId

Property

Type: string | null | undefined

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

isContentVisible

Property

Type: boolean | null | undefined

Specifies the content visibility on the map.

percentAlong

Property

Type: number | null | undefined

This double parameter of value of 0-1 indicates a percentage along the line of where the trace location is placed. Applicable to line features only.

Example

Line feature with objectId 100 with 2 midspan junctions (j1,j2). The line feature has 3 edge network elements
F-j1, j1-j2 and j2-T.

                                       OID=100
                               F------j1------j2------T

F-j1  (objectId=100, positionFrom=0, positionTo=0.33)
j1-j2 (objectId=100, positionFrom=0.33, positionTo=0.66)
j2-T  (objectId=100, positionFrom=0.66, positionTo=1)

When percentAlong is 0.5 (50%) the starting location will be placed on the middle edge (j1-j2)

                                       OID=100
                               F------j1---x--j2------T

When percentAlong is 0.1 (10%) the starting location will be placed on the first edge (F-j1)

                                       OID=100
                               F-x----j1------j2------T

status

Property

Type: number | null | undefined

Indicates the type of association a feature or object participates in, the role the network feature plays in the association relationship, and any properties that are set.

See also

ArcGIS Pro: Association status attribute

toNetworkElement

autocast Property

Type: NetworkElement | null | undefined

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

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.