ColumnTemplate

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

A ColumnTemplate formats and defines the structure of a Column within a FeatureTable widget.

The FieldColumnTemplate is set directly on the table's template or its view model. The FeatureTable's tableTemplate contains a collection of column, field and/or group templates.

See also:

Constructors

new ColumnTemplate(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
Stringmore details

The name of the class.

more detailsAccessor
String|nullmore details

Controls the sort order of the column.

more detailsColumnTemplateBase
Booleanmore details

Indicates whether the field is editable.

more detailsColumnTemplate
Numbermore details

Use this in combination with FeatureTable.multiSortEnabled and FeatureTable.direction properties to set sorting functionality on multiple columns.

more detailsColumnTemplateBase
Stringmore details

A string value containing the column alias.

more detailsColumnTemplateBase
ButtonMenuConfigmore details

Set this object to customize the column's menu content.

more detailsColumnTemplateBase
Booleanmore details

Indicates whether a field requires a value.

more detailsColumnTemplate
Booleanmore details

Indicates whether the field column can be sorted.

more detailsColumnTemplateBase
Stringmore details

Aligns the columns cell content horizontally.

more detailsColumnTemplateBase
Stringmore details

The 'type' of column that the template represents.

more detailsColumnTemplate
Booleanmore details

Indicates whether the column is visible.

more detailsColumnTemplateBase

Property Details

declaredClass Stringreadonly inherited

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

direction String|null inherited

Controls the sort order of the column. This property will only be honored on one column in the FeatureTable widget. If direction is specified on more than one fieldColumn in the same FeatureTable, it will only be honored on the column with the highest index. For example, let's say the first column called ObjectId is set to asc and another column later in the table order also has a set direction, the initial ObjectId column's direction will be ignored for the last one with the set direction.

Use this in combination with the FieldColumnTemplate.initialSortPriority and FeatureTable.multiSortEnabled properties to set sorting functionality for multiple columns.

Possible Value Description
asc Sorts the column in ascending order.
desc Sorts the column in descending order.
null No sort is applied to the column.

Possible Values:"asc"|"desc"

Default Value:null
See also:
editable Boolean

Indicates whether the field is editable. Editing permissions can be broken down with the following levels of priority:

  1. Field - This is derived from the FeatureLayer or SceneLayer. It takes what is set in the Field.editable property. This must always be true for editing to be enabled. This can be overridden using a field column template.
  2. Template - The editable permissions on a field can be configured by setting the editable property of the FieldColumnTemplate.
  3. FeatureTable - The editingEnabled property must be set on the table in order for any type of editing to be enabled.

For example, if table editing is disabled in the widget, i.e. enableEditing is not set, it is still possible to enable editing for a specific column by setting the editable property. Vice versa is also true, if table editing is enabled, a field template can be used to disable editing for a specific column.

Ultimately, if the service's field is not editable, it is not possible to override its permissions using one of the options above.

See also:
initialSortPriority Number inherited

Use this in combination with FeatureTable.multiSortEnabled and FeatureTable.direction properties to set sorting functionality on multiple columns. This property indicates the index of the sorted column when compared to other columns, with lower numbers taking a higher priority.

If no sort priority is set, the priority defaults to the most recently-sorted column. This occurs when sorting via the UI, or programmatically by calling FeatureTable.sortColumn. For example, using the example snippet below, the sort order priority is set for three columns, with "Status" having the least priority. Calling table.sortColumn("Status", "asc") would update the Status column to the highest priority. This would also occur if manually sorting via the column's UI.

Default Value:null
See also:
Example:
const table = new FeatureTable({
  layer: featureLayer,
  multiSortEnabled: true,
  tableTemplate: { // autocastable to TableTemplate
    columnTemplates: [{ // autocastable to FieldColumnTemplate
      fieldName: "ObjectId",
      direction: "asc",
      initialSortPriority: 1, // This field's sort order takes second-highest priority.
    },
    {
      fieldName: "Name",
      direction: "asc",
      initialSortPriority: 0, // This field's sort order takes the highest priority.
    },
    {
      fieldName: "Status",
      direction: "asc",
      initialSortPriority: 2 // This field's sort order is prioritized after Name and ObjectId, respectively.
    }]
  }
  container: "tableDiv"
});

A string value containing the column alias.

Set this object to customize the column's menu content.

See also:
required Boolean

Indicates whether a field requires a value.

Default Value:false
sortable Boolean inherited

Indicates whether the field column can be sorted.

Default Value:true
textAlign String inherited

Aligns the columns cell content horizontally. Supported values: "start" | "center" | "end".

Possible Values:"start"|"center"|"end"

Default Value:start
type Stringreadonly

The 'type' of column that the template represents.

For ColumnTemplate the type is always "column".

visible Boolean inherited

Indicates whether the column is visible.

Default Value:true

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class
*more details

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

more detailsColumnTemplateBase
Objectmore details

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

more detailsColumnTemplateBase

Method Details

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

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.