FieldIndex | References | ArcGIS Maps SDK for JavaScript

import FieldIndex from "@arcgis/core/rest/knowledgeGraph/FieldIndex.js";

const FieldIndex = await $arcgis.import("@arcgis/core/rest/knowledgeGraph/FieldIndex.js");

Inheritance: FieldIndex→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.25

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

Constructor

Parameters

Parameter	Type	Description	Required
properties	FieldIndexProperties

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.

Property	Type	Class
ascending	boolean
declaredClass readonly inherited	string	Accessor
description readonly	string
fieldNames	string[]
name	string
unique	boolean

ascending

Property

Type: boolean

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

Default value: true

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

description

readonly Property

Type: string

Description of the field.

Default value: ""

fieldNames

Property

Type: string[]

The ordered field names included in this index.

name

Property

Type: string

The name of the field.

unique

Property

Type: boolean

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

Methods

Method	Signature	Class
fromJSON inherited static	fromJSON(json: any): any	JSONSupportMixin
toJSON inherited	toJSON(): any	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	any	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: any
Returns a new instance of this class.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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

Returns: any
The ArcGIS portal JSON representation of an instance of this class.