QueryAssociationsParameters | References | ArcGIS Maps SDK for JavaScript

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

Inheritance:: QueryAssociationsParameters→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.24

QueryAssociationsParameters describes the parameters required to execute the queryAssociations function, which returns a list of associations filtered by the parameters set.

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	`QueryAssociationsParametersProperties`

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
`declaredClass` readonly inherited	`string`	Accessor
`elements`	`NetworkElement[]`
`gdbVersion`	`string \| null \| undefined`
`moment`	`Date \| null \| undefined`
`returnDeletes`	`boolean`
`types`	`AssociationType[]`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

elements

autocast Property

Type: NetworkElement[]

The NetworkElements for which the association is queried.

gdbVersion

Property

Type: string | null | undefined

The geodatabase version to execute the function against. Defaults to SDE.DEFAULT, if no version is provided.

moment

autocast Property

Type: Date | null | undefined

The date/timestamp (in UTC) to execute the function. This could be used to run the function in a moment in the past or in long transaction mode (undo/redo). Applicable to branch versioned datasets only.

See also

Learn more about branch versioning.

returnDeletes

Property

Type: boolean

If true, the response includes associations that have been deleted.

Default value: false

types

Property

Type: AssociationType[]

The association types to query. Junction-edge connectivity associations are used to establish a relationship between a point feature or junction object and an edge object.

Junction-edge from connectivity
Junction-edge midspan connectivity
Junction-edge to connectivity

These association types enable connectivity to be established between nonspatial junction and edge objects and provide an additional method to model connectivity between noncoincident point features using an edge object.

Possible Values

Value	Description
connectivity	Allows modeling the connectivity between two features that are not coincident or between spatial features and nonspatial junction and edge objects.
junction-junction-connectivity	Allows modeling the connectivity between two features that are not coincident or between spatial features and nonspatial junction and edge objects.
attachment	Allows the modeling of supporting structures and attachments in a network.
containment	Allows a dense collection of features to be represented by a single feature.
junction-edge-from-connectivity	Junction edge from connectivity.
junction-edge-midspan-connectivity	Junction edge midspan connectivity.
junction-edge-to-connectivity	Junction edge to connectivity.

The "connectivity" type has been deprecated since version 4.29. Please use "junction-junction-connectivity" instead.

See also

ArcGIS Pro: Connectivity associations

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.