require(["esri/tables/elements/AttributeTableElement"], (AttributeTableElement) => { /* code goes here */ });
import AttributeTableElement from "@arcgis/core/tables/elements/AttributeTableElement.js";
esri/tables/elements/AttributeTableElement
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:
- AttributeTableFieldElement
- AttributeTableGroupElement
- AttributeTableRelationshipElement
- AttributeTableAttachmentElement
The AttributeTableElement
class is a read-only base class which has no constructor.
- See also
-
- FeatureTable
- esri/tables/AttributeTableTemplate/
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The name of the class. | Accessor | ||
The table element's description which provides the purpose behind it. | AttributeTableElement | ||
A string value containing the field alias. | AttributeTableElement | ||
The type of table element to display. | AttributeTableElement |
Property Details
-
description
description String
-
The table element's description which provides the purpose behind it.
-
label
label String
-
A string value containing the field alias.
-
type
type Stringreadonly
-
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 layers and tables and how they participate in the FeatureTable. Possible Values:"attachment" |"field" |"group" |"relationship"
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 new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | AttributeTableElement | |
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. | AttributeTableElement |
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.
-
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.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 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"); }
-
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
toJSON(){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.