TableTemplate

AMD: require(["esri/widgets/FeatureTable/support/TableTemplate"], (TableTemplate) => { /* code goes here */ });
ESM: import TableTemplate from "@arcgis/core/widgets/FeatureTable/support/TableTemplate";
Class: esri/widgets/FeatureTable/support/TableTemplate
Inheritance: TableTemplate Accessor
Since: ArcGIS API for JavaScript 4.24

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.

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

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)>more details

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

more detailsTableTemplate
Stringmore details

The name of the class.

more detailsAccessor

Property Details

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 Stringreadonly inherited

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

Method Overview

Name Return Type Summary Class
TableTemplatemore details

Creates a deep clone of the TableTemplate class.

more detailsTableTemplate
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsTableTemplate
Objectmore details

Converts an instance of this class to its ArcGIS portal JSON representation.

more detailsTableTemplate

Method Details

clone(){TableTemplate}

Creates a deep clone of the TableTemplate class.

Returns:
Type Description
TableTemplate A deep clone of the TableTemplate instance.
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.
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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.