SearchIndex

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

Defines a search index for a KnowledgeGraph.

Example
//structure of a search index in a knowledge graph data model.
{
	"analizers": [
		{
			"name": "text_en"
		}
	],
	"name": "esri__search_idx",
	"searchProperties": [
		{
			"key": "Supplier",
			"value": {
				"propertyNames": [
					"name",
					"EmployeeCount",
					"globalid"
				]
			}
		},
		{
			"key": "buys_part",
			"value": {
				"propertyNames": [
					"quantity",
					"globalid"
				]
			}
		},
		{
			"key": "Part",
			"value": {
				"propertyNames": [
					"name",
					"globalid"
				]
			}
		}
	],
	"supportedCategory": "Both"
}

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
Object[]

Additional analyzers for string processing during search such as support for languages.

SearchIndex
String

The name of the class.

Accessor
String

The name of the search index.

SearchIndex
Object[]

A map of the named types and their properties that are included in the search index.

SearchIndex
String

Specifies if the index supports searching entities, relationships or both.

SearchIndex

Property Details

analyzers Object[]readonly

Additional analyzers for string processing during search such as support for languages.

Property
name String

The name of the analyzer.

declaredClass Stringreadonly inherited

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

name Stringreadonly

The name of the search index.

searchProperties Object[]readonly

A map of the named types and their properties that are included in the search index.

Property
propertyNames String[]

The properties of the named type that are included in the search index.

supportedCategory Stringreadonly

Specifies if the index supports searching entities, relationships or both.

Possible Values:"esriTypeEntity"|"esriTypeRelationship"|"esriTypeBoth"

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(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 }
);

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(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.