Path | API Reference | ArcGIS Maps SDK for JavaScript 4.31

An object containing all entities and relationships required to traverse a graph from one entity to another. A path can be restricted by the type and number of relationships used to connect entities. For example, a query that asks for the path between entity a and entity c would return a Path containing the relationships between a-b and b-c as well as the entities a, b, and c.

Sample of the structure of a path object returned from knowledgeGraphService.executeQuery() using the query MATCH q = (a)-->()-->(c) RETURN q LIMIT 1 which returns a path with intermediary entity.

KnowledgeGraphModule.executeQuery(
 knowledgeGraph, //graph
 {
   //query returning path from `a` to `c` with any intermediary entity
   openCypherQuery: "MATCH q = (a)-->()-->(c) RETURN q LIMIT 1",
  }).then((queryResult) => {
    //do something with the result
   //console.log(queryResult.ResultRows)
});

//sample output from the above query
[{
 "declaredClass": "esri.rest.knowledgeGraph.Path",
 "path": [
     {// entity `a`
      "declaredClass": "esri.rest.knowledgeGraph.Entity",
      "properties": {
       "name": "ABC Contractors",
       "CompanyType": "Construction",
     },
     "typeName": "Company",
     "id": "C1234"
   },
   { //relationship `a-b`
     "declaredClass": "esri.rest.Relationship.Relationship",
     "originID": "C1234",
     "destinationID": "S444",
     "properties": {
        "contract_expiration_date": "2025-05-26",
        "contact_person": "Jon Doe"
     },
     "typeName": "supplied_by",
     "id": "SB001"
   },
   { //entity `b`
    "declaredClass": "esri.rest.knowledgeGraph.Entity",
     "properties": {
       "objectid": 1,
       "shape": {
         "declaredClass": "esri.geometry.Point",
         "cache": {},
         "hasM": false,
         "hasZ": false,
         "latitude": 53.589000000000009,
         "longitude": -0.9633,
         "type": "point",
         "extent": null,
         "spatialReference": {
           "wkid": 4326
         },
         "x": -0.9633,
         "y": 53.589000000000009
       },
       "Employee_Count": 400,
       "Name": "Quality Metal Supply",
     },
     "typeName": "Supplier",
     "id": "S444",
   },
   { //relationship `b-c`
     "declaredClass": "esri.rest.Relationship.Relationship",
     "originID": "S444",
     "destinationID": "P789",
     "properties": {
       "frequency": "2 weeks",
       "quantity": 125000,
     },
     "typeName": "buys_part",
     "id": "BP456"
   },
   {// entity `c`
     "declaredClass": "esri.rest.knowledgeGraph.Entity",
     "properties": {
       "Name": "steel plate",
       "width": "15cm",
       "height": "10cm"
     },
     "typeName": "Part",
     "id": "P789"
   }
 ]
}]

Constructors

Path Constructor new Path(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
	String	The name of the class.	Accessor
	GraphNamedObject []	Array of entities and relationships where the first element is the starting entity of the path, the final element is the ending entity of the path, and intermediary elements are entities and relationships connecting the two.	Path

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.

path Property path GraphNamedObject[]

Array of entities and relationships where the first element is the starting entity of the path, the final element is the ending entity of the path, and intermediary elements are entities and relationships connecting the two.

Method Overview

Show inherited methods

Hide inherited methods

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.	Path
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	Path

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor

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

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

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.