QueryAssociationsParameters

AMD: require(["esri/rest/networks/support/QueryAssociationsParameters"], (QueryAssociationsParameters) => { /* code goes here */ });
ESM: import QueryAssociationsParameters from "@arcgis/core/rest/networks/support/QueryAssociationsParameters.js";
Class: esri/rest/networks/support/QueryAssociationsParameters
Inheritance: QueryAssociationsParametersAccessor
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
// Utility network service url
const networkServiceUrl = "https://myserver.esri.com/server/rest/services/NapervilleElectric/UtilityNetworkServer";

// Define the QueryAssociationsParameters
const queryAssociationsParameters = new QueryAssociationsParameters({
  associationTypes: ["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 of type QueryAssociationsResult
const queryAssociationsResult = await queryAssociations(networkServiceUrl, queryAssociationsParameters);

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

Constructors

QueryAssociationsParameters

Constructor
new QueryAssociationsParameters(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
Name Type Summary Class

The name of the class.

Accessor

The NetworkElements for which the association is queried.

QueryAssociationsParameters

The geodatabase version to execute the function against.

QueryAssociationsParameters

The date/timestamp (in UTC) to execute the function.

QueryAssociationsParameters

Specifies whether to return logically deleted associations.

QueryAssociationsParameters

Specifies an array of Association types to be queried.

QueryAssociationsParameters

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.

elements

Property
elements NetworkElement[]

The NetworkElements for which the association is queried.

gdbVersion

Property
gdbVersion String

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

moment

Property
moment Date

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.

returnDeletes

Property
returnDeletes Boolean

Specifies whether to return logically deleted associations.

Default Value:false

types

Property
types String[]

Specifies an array of Association types to be queried. This is provided as an array of strings.

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

Method Overview

Show inherited methods Hide inherited methods
Name 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.

QueryAssociationsParameters

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

Converts an instance of this class to its ArcGIS portal JSON representation.

QueryAssociationsParameters

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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.