FieldIndex

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

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
//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

new FieldIndex(properties)
Parameter
properties Object
optional

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
Boolean

Specifies if the field is indexed in ascending order.

more details
FieldIndex
String

The name of the class.

more details
Accessor
String

Description of the field.

more details
FieldIndex
String[]

The ordered field names included in this index.

more details
FieldIndex
String

The name of the field.

more details
FieldIndex
Boolean

Specifies if the values in the field are unique (no duplicate values).

more details
FieldIndex

Property Details

ascending Boolean

Specifies if the field is indexed in ascending order. If false the field is indexed in descending order.

Default Value:true
declaredClass Stringreadonly inherited

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

description String

Description of the field.

fieldNames String[]

The ordered field names included in this index.

name String

The name of the field.

unique Boolean

Specifies if the values in the field are unique (no duplicate values).

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.

more details
Accessor
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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.