require(["esri/tables/AttributeTableTemplate"], (AttributeTableTemplate) => { /* code goes here */ });
import AttributeTableTemplate from "@arcgis/core/tables/AttributeTableTemplate.js";
esri/tables/AttributeTableTemplate
An AttributeTableTemplate manages the configuration of how the FeatureTable widget displays its columns. This template allows you to define properties such as visibility, order, and sorting of the table's columns. It can be applied directly to a Featurelayer, CSVLayer, GeoJSONLayer, CatalogFootprintLayer, SubtypeSubLayer, a FeatureTable, or FeatureTable's view model. The AttributeTableTemplate consists of various elements that represent specific types of columns in a table. It can be serialized to JSON, enabling the persistence of the table's configuration. This feature facilitates easy sharing and reuse of table configurations across different applications.
Tables can be created with a variety of elements, including:
- AttributeTableFieldElement: Represents a column within the table that represents an individual field.
- AttributeTableAttachmentElement: Represents a column within the table that represents an attachment.
- AttributeTableRelationshipElement: Represents a column within the table that represents a relationship.
- AttributeTableGroupElement: Represents a group of
field,relationship, orattachmentelements in the table.
If a table is configured using another application such as Map Viewer, the resulting saved layer or web map item's JSON will contain a attributeTableInfo object.
Considerations
The layers that honor the attributeTableTemplate property are:
- FeatureLayer
- CSVLayer
- GeoJSONLayer
- CatalogFootprintLayer
- SubtypeSubLayer
This class differs from esri/widgets/FeatureTable/support/TableTemplate. The TableTemplate class provides more fine-grained control over how the table is rendered within an application by offering more advanced configurations such as custom cell rendering, column formatting, and more. TableTemplate is useful for application-level development that remains within an application. Use AttributeTableTemplate to access the table's settings across different applications since they can be saved within a webmap or layer. Please refer to the TableTemplate documentation for more information.
The FeatureTable prioritizes the table's configurations in the following order:
- The tableTemplate defined in the FeatureTable.
- The attributeTableTemplate defined in the FeatureTable.
- The
attributeTableTemplatedefined in the layer or standalone table. - Default columns are generated based on the layer's fields if no table templates exist.
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 |
|---|---|---|---|
The name of the class. | Accessor | ||
An array of attribute table element objects that represent an ordered list of table elements. | AttributeTableTemplate | ||
An Array of FieldOrder objects indicating the records' sort order. | AttributeTableTemplate |
Property Details
-
elements
Propertyelements Array<(AttributeTableAttachmentElement|AttributeTableFieldElement|AttributeTableGroupElement|AttributeTableRelationshipElement)>autocast -
An array of attribute table element objects that represent an ordered list of table elements.
Table elements are designed to allow the table author the ability to define the layout for fields when displaying and/or editing data.
Nested group table elements are not supported.
-
orderByFields
PropertyorderByFields FieldOrder[] -
An Array of FieldOrder objects indicating the records' sort order.
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 deep clone of the AttributeTableTemplate class. | AttributeTableTemplate | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | AttributeTableTemplate | |
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. | AttributeTableTemplate |
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.
-
clone
Methodclone(){AttributeTableTemplate} -
Creates a deep clone of the AttributeTableTemplate class.
ReturnsType Description AttributeTableTemplate A deep clone of the AttributeTableTemplate instance.
-
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.
Type Definitions
-
This object sets a field and sort order for how records display within the table.