ColumnTemplateBase

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

The base class for all column templates used by the tableTemplate within the FeatureTable widget.

ColumnTemplateBase is a base class which has no 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
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 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 detailsColumnTemplateBase
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

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:
initialSortPriority Number

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"
});
label String

A string value containing the column alias.

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

See also:
sortable Boolean

Indicates whether the field column can be sorted.

Default Value:true
textAlign String

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.

Possible Values:"column"|"field"|"group"

visible Boolean

Indicates whether the column is visible.

Default Value:true

Method Overview

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}

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.