require(["esri/rest/knowledgeGraph/GraphQueryResult"], (GraphQueryResult) => { /* code goes here */ });
import GraphQueryResult from "@arcgis/core/rest/knowledgeGraph/GraphQueryResult.js";
esri/rest/knowledgeGraph/GraphQueryResult
The results of a executeQuery() or executeSearch() on a knowledge graph service.
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
| String | The name of the class. | Accessor | |
| Array<Array<(Path|GraphObject|Geometry|Date|string|number|null|Array<(Path|GraphObject|Geometry|Date|string|number|null)>)>> | An array of the result types that are returned from a search or query. | GraphQueryResult |
Property Details
-
An array of the result types that are returned from a search or query. Each item in the
resultRowsarray 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
| Name | 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
-
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();ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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
InheritedMethodhasHandles(groupKey){Boolean}Inherited from Accessor -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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"); }
-
Inherited from Accessor
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");