GraphSearch

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

The search operation is performed on a knowledge graph service's graph resource. This operation allows you to search the properties of both entities and relationships in the graph. Any field with the Text data type or the Globally Unique Identifier (GUID) data type with the searchable properties set to true is included in the search. A search index is built and maintained automatically on the values for all searchable fields.

See also
Examples
//searches for 'solar' in the properties of all entities in the knowledge graph
require([
 "esri/rest/knowledgeGraphService"
], (KnowledgeGraphModule) => {
 KnowledgeGraphModule
   .executeSearch(kg, {
     searchQuery: "solar",
     typeCategoryFilter: "entity",
   })
   .then((queryResult) => {
     // do something with the search results
     console.log("Graph Search Result", queryResult);
   });
});
//sample return from above search
[{
 "declaredClass": "esri.rest.knowledgeGraph.Entity",
 "properties": {
   "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
   },
   "Name": "Suncommon",
   "Employee_Count": 400,
   "energyType": "solar"
 },
 "typeName": "Company",
 "id": "156786"
}]

Constructors

GraphSearch

Constructor
new GraphSearch(properties)
Parameter
properties Object

The searchQuery property is required. 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.

Accessor
String

The text to search for in the knowledge graph.

GraphSearch
String

Specifies whether to search entities, relationships, or both.

GraphSearch

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.

searchQuery

Property
searchQuery String

The text to search for in the knowledge graph. Accepts Lucene search syntax.

Required

typeCategoryFilter

Property
typeCategoryFilter String

Specifies whether to search entities, relationships, or both. Valid values are entity, relationship, or both.

Note

Required

  • This property is required for the search to execute successfully. If the service does not support both one of the other options must be specified.

Possible Values:"entity"|"relationship"|"both"

Default Value:"both"

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.

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

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