Path

AMD: require(["esri/rest/knowledgeGraph/Path"], (Path) => { /* code goes here */ });
ESM: import Path from "@arcgis/core/rest/knowledgeGraph/Path";
Class: esri/rest/knowledgeGraph/Path
Inheritance: Path Accessor
Since: ArcGIS API for JavaScript 4.25
beta

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

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.

more details
Accessor
GraphObject[]

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.

more details
Path

Property Details

declaredClass Stringreadonly inherited

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

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
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor

Method Details

addHandles(handleOrHandles, groupKey)inherited

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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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.

hasHandles(groupKey){Boolean}inherited

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(groupKey)inherited

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");

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