GraphQuery

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

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

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 Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The name of the class.

more details
Accessor
String

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

more details
GraphQuery

Property Details

declaredClass Stringreadonly inherited

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

openCypherQuery String

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

Required

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.