Skip to content
import SearchIndex from "@arcgis/core/rest/knowledgeGraph/SearchIndex.js";
Inheritance:
SearchIndexAccessor
Since
ArcGIS Maps SDK for JavaScript 4.26

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"
}

Constructors

Constructor

Constructor
Parameters
ParameterTypeDescriptionRequired
properties
See the properties table for a list of all the properties that may be passed into the constructor.

Properties

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

analyzers

readonly Property
Type
SearchIndexAnalyzer[]

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

declaredClass

readonlyinherited Property
Type
string
Inherited from: Accessor

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

name

readonly Property
Type
string

The name of the search index.

searchProperties

readonly Property
Type
Map<string, SearchProperties>

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

supportedCategory

readonly Property
Type
EsriNamedTypeCategories

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

Default value
"esriTypeUNSPECIFIED"

Type definitions

SearchIndexAnalyzer

Type definition

name

Property
Type
string

The name of the analyzer.

SearchProperties

Type definition

Search properties.

propertyNames

Property
Type
string[]

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