GraphQueryResult | API Reference | ArcGIS Maps SDK for JavaScript 4.31

The results of a executeQuery() or executeSearch() on a knowledge graph service.

See also

Constructors

GraphQueryResult Constructor new GraphQueryResult(properties)

Parameter

properties Object

optional

See the properties for a list of all the properties.

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
	GraphAnyValue [][]	An array of the result types that are returned from a search or query.	GraphQueryResult

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.

resultRows Property resultRows GraphAnyValue[][]

An array of the result types that are returned from a search or query. Each item in the resultRows array matches the search or query constraints.

Examples

// Example of GraphQueryResult.resultRows returned from a
// `MATCH (n:Supplier)-[r]->(m) RETURN [n.id, n.geometry, n, r, m], {var1: n}`
// query on a knowledge graph that contains supply chain information
KnowledgeGraphModule.executeQuery(
 knowledgeGraph, //graph
 { //searchArguments
   openCypherQuery: "MATCH (n:Supplier)-[r]->(m) RETURN [n.id, n.geometry, n, r, m], {var1: n}",
  }).then((queryResult) => {
    //do something with the result
   console.log(queryResult)
});

//sample result of the above query
"resultRows": [
 [ //array of result types that meet query criteria
   [ //single return type that matches query return format.
     1111,
     "Point",
     {  //Supplier Entity
       "properties": {
         "Name": "Queen City Steel",
       },
       "typeName": "Supplier",
       "id": "1111"
     },
     { // 'supplies' relationship between Supplier and Plant
       "destinationId": "1111",
       "originId": "1236",
       "properties": {
         "material_supplied": "steel"
       },
       "typeName": "supplies",
       "id": "A268",
     },
     { //destination entity of 'supplies' for supplier 1111
       "properties": {
         "Name": "Sky Manufacturing",
       },
       "typeName": "Plant",
       "id": "1236"
     }
   ],
   {  // anonymous object returned by the `{var1:n}` query parameter
     "properties": {
       "var1": { //the entity (n) returned in the var1 object
         "properties": {
           "Name": "Queen City Steel",
       },
         "typeName": "Supplier",
         "id": "1111"
       }
     }
   }
 ]
]

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
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor

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.

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

Type Definitions