require(["esri/rest/knowledgeGraph/SearchIndex"], (SearchIndex) => { /* code goes here */ });
import SearchIndex from "@arcgis/core/rest/knowledgeGraph/SearchIndex.js";
esri/rest/knowledgeGraph/SearchIndex
Defines a search index for a KnowledgeGraph.
//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
| 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
-
Additional analyzers for string processing during search such as support for languages.
- Property
-
name String
The name of the analyzer.
-
name
Propertyname Stringreadonly -
The name of the search index.
-
A map of the named types and their properties that are included in the search index.
-
supportedCategory
PropertysupportedCategory Stringreadonly -
Specifies if the index supports searching entities, relationships or both.
Possible Values:"esriTypeEntity"|"esriTypeRelationship"|"esriTypeBoth"
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");