TableTemplate | API Reference | ArcGIS Maps SDK for JavaScript 4.31

A TableTemplate formats and defines the content of a FeatureTable.

The TableTemplate can be set directly on a FeatureTable or its view model. The template consists of various column templates that can be configured for both individual fields and grouped fields.

Considerations

This class differs from esri/tables/AttributeTableTemplate. TableTemplate provides more fine-grained control over how the table is rendered within the 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 esri/tables/AttributeTableTemplate to access the table's settings across different applications. By using this, the table's column settings can be saved within a webmap or layer. Please refer to the AttributeTableTemplate documentation for more information.

The FeatureTable prioritizes the table's configurations in the following order:

1. The tableTemplate defined in the FeatureTable.
1. The attributeTableTemplate defined in the FeatureTable.
1. The AttributeTableTemplate defined in the layer or standalone table.
1. Default columns are generated based on the layer's fields if no table templates exist.

Example

const tableTemplate = new TableTemplate({
  columnTemplates: [ // takes an array of FieldColumnTemplate and GroupColumnTemplate
  { // autocasts to FieldColumnTemplate
    type: "field",
    fieldName: "ObjectId",
    direction: "asc", // In order to use initialSortPriority, make sure direction is set
    initialSortPriority: 1 // This field's sort order takes the second-highest priority.
  },
  {
    type: "field",
    fieldName: "NAME",
    label: "Name",
    direction: "asc", // In order to use initialSortPriority, make sure direction is set
    initialSortPriority: 0 // This field's sort order takes the highest priority
  },
  {
    type: "field",
    fieldName: "STATUS",
    label: "Status",
    direction: "asc", // In order to use initialSortPriority, make sure direction is set
    initialSortPriority: 2 // This field's sort order is prioritized after Name and ObjectId, respectively.
  }]
});

Constructors

TableTemplate Constructor new TableTemplate(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
	Array<(FieldColumnTemplate\|GroupColumnTemplate\|ColumnTemplate)>	A collection of field column templates and/or group column templates that represent an ordered list of column templates.	TableTemplate
	String	The name of the class.	Accessor

Property Details

columnTemplates Property columnTemplates Array<(FieldColumnTemplate|GroupColumnTemplate|ColumnTemplate)>autocast

A collection of field column templates and/or group column templates that represent an ordered list of column templates.

Column templates are designed to allow the developer the ability to define the structure for columns within the FeatureTable widget.

See also

Example

const tableTemplate = new TableTemplate({
  columnTemplates: [
  { // autocasts to FieldColumnTemplate
    type: "field",
    fieldName: "ObjectId",
    direction: "asc",
    initialSortPriority: 1 // This field's sort order takes the second-highest priority.
  },
  {
    type: "field",
    fieldName: "NAME",
    label: "Name",
    initialSortPriority: 0 // This field's sort order takes the highest priority
  },
  {
    type: "field",
    fieldName: "STATUS",
    label: "Status",
    direction: "asc",
    initialSortPriority: 2 // This field's sort order is prioritized after Name and ObjectId, respectively.
  }]
});

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
TableTemplate	Creates a deep clone of the TableTemplate class.	TableTemplate
*	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	TableTemplate
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	TableTemplate

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

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.

clone Method clone(){TableTemplate}

Creates a deep clone of the TableTemplate class.

Returns

Type	Description
TableTemplate	A deep clone of the TableTemplate instance.

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 Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

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 Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

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.