AttributeTableElement | References | ArcGIS Maps SDK for JavaScript

import AttributeTableElement from "@arcgis/core/tables/elements/AttributeTableElement.js";

Inheritance:: AttributeTableElement→Accessor

Subclasses:: AttributeTableAttachmentElement, AttributeTableFieldElement, AttributeTableGroupElement, AttributeTableRelationshipElement

Since: ArcGIS Maps SDK for JavaScript 4.31

Attribute table elements define what should display within the AttributeTableTemplate elements. These elements can be fields, groups, relationships, or attachments and are used to configure how the data is presented in a FeatureTable.

There are four specific table element types:

The AttributeTableElement class is a read-only base class which has no constructor.

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`AttributeTableElementProperties`

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
`declaredClass` readonly inherited	`string`	Accessor
`description`	`string \| null \| undefined`
`label`	`string \| null \| undefined`
`type` readonly	`TableElementType`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

description

Property

Type: string | null | undefined

The table element's description which provides the purpose behind it.

label

Property

Type: string | null | undefined

A string value containing the field alias.

type

readonly Property

Type: TableElementType

The type of table element to display.

Possible Value	Description
attachment	An individual attachment element that defines an input for attachments in a AttributeTableTemplate.
field	An individual field element that defines the field within the table template.
group	Contains a grouping of field elements.
relationship	A relationship element defines a relationship between Map.layers and Map.tables and how they participate in the FeatureTable.

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.