FieldIndex

AMD: require(["esri/rest/knowledgeGraph/FieldIndex"], (FieldIndex) => { /* code goes here */ });
ESM: import FieldIndex from "@arcgis/core/rest/knowledgeGraph/FieldIndex.js";
Class: esri/rest/knowledgeGraph/FieldIndex
Inheritance: FieldIndex Accessor
Since: ArcGIS Maps SDK 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

FieldIndex

Constructor
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

Specifies if the field is indexed in ascending order.

FieldIndex

The name of the class.

Accessor

Description of the field.

FieldIndex

The ordered field names included in this index.

FieldIndex

The name of the field.

FieldIndex

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

FieldIndex

Property Details

ascending

Property
ascending Boolean

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

Default Value:true

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

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

description

Property
description String

Description of the field.

fieldNames

Property
fieldNames String[]

The ordered field names included in this index.

name

Property
name String

The name of the field.

unique

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

Accessor
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

FieldIndex

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

Converts an instance of this class to its ArcGIS portal JSON representation.

FieldIndex

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
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();
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.

fromJSON

Method
fromJSON(json){*}static

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 json parameter 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.

Parameter
json Object

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

Returns
Type Description
* Returns a new instance of this class.

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor

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

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor

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");

toJSON

Method
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.