require(["esri/rest/knowledgeGraph/FieldIndex"], (FieldIndex) => { /* code goes here */ });
import FieldIndex from "@arcgis/core/rest/knowledgeGraph/FieldIndex.js";
esri/rest/knowledgeGraph/FieldIndex
Defines an index on fields associated with an entity type or relationship type. The results from executeSearch() on a knowledge graph service will include content from indexed text and GUID fields.
//example of a field index on the `name` field
"fieldIndexes": [
{
"declaredClass": "esri.rest.knowledgeGraph.FieldIndex",
"name": "esri__name_idx",
"unique": true,
"ascending": true,
"description": "index on name field",
"fieldNames": [
"name"
]
}
]Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
| Boolean | Specifies if the field is indexed in ascending order. | FieldIndex | |
| String | The name of the class. | Accessor | |
| String | Description of the field. | FieldIndex | |
| String[] | The ordered field names included in this index. | FieldIndex | |
| String | The name of the field. | FieldIndex | |
| Boolean | Specifies if the values in the field are unique (no duplicate values). | FieldIndex |
Property Details
-
ascending
Propertyascending Boolean -
Specifies if the field is indexed in ascending order. If
falsethe field is indexed in descending order.- Default Value:true
-
description
Propertydescription String -
Description of the field.
-
name
Propertyname String -
The name of the field.
-
unique
Propertyunique Boolean -
Specifies if the values in the field are unique (no duplicate values).
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | FieldIndex | |
| Boolean | Returns true if a named group of handles exist. | Accessor | |
Removes a group of handles owned by the object. | Accessor | ||
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. | FieldIndex |
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.
-
Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input
jsonparameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.Parameterjson ObjectA JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.
ReturnsType Description * Returns a new instance of this class.
-
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");
-
toJSON
MethodtoJSON(){Object} -
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.