GraphQuery | API Reference | ArcGIS Maps SDK for JavaScript 4.31

Defines the query operation performed on a knowledge graph service's graph resource. The entities and relationships in the graph are queried by sending an Esri implementation of openCypher query.

Notes

ArcGIS Knowledge does not support write capabilities of the openCypher query language. All openCypher queries must be read-only.

See also

Example

//typical use case
KnowledgeGraphModule.executeQuery(
 knowledgeGraph, //graph
 { //queryArguments
   openCypherQuery: "MATCH (n) RETURN n LIMIT 1", //query
  }).then((queryResult) => {
    //do something with the result
});

Constructors

GraphQuery Constructor new GraphQuery(properties)

Parameters

properties Object

The openCypherQuery property is required. See the properties for full list of the properties that may be passed into the constructor.

Specification

openCypherQuery String

The Esri implementation of the openCypher query to execute against the knowledge graph. See openCypherQuery for additional details.

Property Overview

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Show inherited properties

Hide inherited properties

Name	Type	Summary	Class
	String	The name of the class.	Accessor
	String	The Esri implementation of openCypher query to be executed against the knowledge graph.	GraphQuery

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.

openCypherQuery Property openCypherQuery String

The Esri implementation of openCypher query to be executed against the knowledge graph.

Required

knowledgeGraphService.executeQuery() will fail if not provided.

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