TraverseAssociationsResult | References | ArcGIS Maps SDK for JavaScript

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

const TraverseAssociationsResult = await $arcgis.import("@arcgis/core/rest/networks/support/TraverseAssociationsResult.js");

Inheritance: TraverseAssociationsResult→Accessor

Since: ArcGIS Maps SDK for JavaScript 5.2

Defines the results of the traverseAssociations function which takes in TraverseAssociationsParameters and returns a TraverseAssociationsResult. The result includes associations and UnitIdentifiers filtered by the parameters set.

See also

Example

const traverseAssociationsParameters = new TraverseAssociationsParameters({
  direction: "ascending",
  stopAtFirstSpatial: false,
  elements: [
    {
      networkSourceId: 19,
      globalId: "{AE323515-8E6F-4CC2-B9A8-1DB963E769AB}"
    }
 ]
});

const result = await traverseAssociations(networkServiceUrl, traverseAssociationsParameters);

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	TraverseAssociationsResultProperties

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
associations	Association[]
declaredClass readonly inherited	string	Accessor
objects	UnitIdentifier[] \| null \| undefined

associations

autocast Property

Type: Association[]

List of associations returned filtered based on the input parameters in TraverseAssociationsParameters.

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

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

objects

Property

Type: UnitIdentifier[] | null | undefined

Contains IDs for the objects that are returned during the traversal process based on the input parameters in TraverseAssociationsParameters.

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.