ColumnTemplate | API Reference | ArcGIS Maps SDK for JavaScript 4.31

A ColumnTemplate formats and defines the structure of a Column within a FeatureTable widget. It 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

ColumnTemplate Constructor 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

Type	Summary	Class
Boolean	Indicates if the column width will automatically adjust to account for large content.	ColumnTemplateBase
String	The name of the class.	Accessor
String	A string description of the column to give context to what it represents.	ColumnTemplateBase
String\|null	Controls the sort order of the column.	ColumnTemplateBase
Boolean	Indicates whether the field is editable.	ColumnTemplate
String	The unique field name as defined by the data source.	ColumnTemplateBase
Number	Controls the flex-grow property for the column.	ColumnTemplateBase
FormatFunction	Custom function for rendering cell content that is called when the column is rendered in the table.	ColumnTemplateBase
Boolean	Indicates if the the column is frozen in place at the beginning of the table.	ColumnTemplateBase
Boolean	Indicates if the column is frozen in place at the end of the table.	ColumnTemplateBase
String	The string value indicating the icon displayed in the header cell of the column.	ColumnTemplateBase
Number	Use this in combination with FeatureTable.multiSortEnabled and FeatureTable.direction properties to set sorting functionality on multiple columns.	ColumnTemplateBase
Boolean	Indicates whether the column is in an invalid state.	ColumnTemplateBase
String	The default label displayed in the column header cell.	ColumnTemplateBase
ColumnTableMenuConfig	Configuration options for the column menu.	ColumnTemplateBase
Boolean	Indicates whether a field requires a value.	ColumnTemplate
Boolean	Indicates whether the column is resizable.	ColumnTemplateBase
Boolean	Indicates whether the column can be sorted.	ColumnTemplateBase
String	Aligns the columns cell content horizontally.	ColumnTemplateBase
Boolean	Indicates cell content should be wrapped and displayed on multiple lines within the cell.	ColumnTemplateBase
String	The time zone of the specific column.	ColumnTemplateBase
String	The type of column that the template represents.	ColumnTemplate
Boolean	Indicates whether the column is visible.	ColumnTemplateBase

Property Details

autoWidth Inherited Property autoWidth Boolean Inherited from ColumnTemplateBase Since: ArcGIS Maps SDK for JavaScript 4.30 ColumnTemplateBase since 4.24, autoWidth added at 4.30.

Indicates if the column width will automatically adjust to account for large content. The column ignores the current width property when autoWidth is true.

Default Value:false

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

description Inherited Property description String Inherited from ColumnTemplateBase Since: ArcGIS Maps SDK for JavaScript 4.31 ColumnTemplateBase since 4.24, description added at 4.31.

A string description of the column to give context to what it represents.

See also

direction Inherited Property direction String |null Inherited from ColumnTemplateBase

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 column in the same FeatureTable, it will only be honored on the column with the highest index.

This is used in combination with the 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"

See also

editable Property editable Boolean

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

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.
Template - The editable permissions on a field can be configured by setting the editable property of the FieldColumnTemplate.
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

fieldName Inherited Property fieldName String Inherited from ColumnTemplateBase

The unique field name as defined by the data source.

flexGrow Inherited Property flexGrow Number Inherited from ColumnTemplateBase Since: ArcGIS Maps SDK for JavaScript 4.30 ColumnTemplateBase since 4.24, flexGrow added at 4.30.

Controls the flex-grow property for the column. When set to 0, cell width is fixed.

Default Value:1

formatFunction Inherited Property formatFunction FormatFunction Inherited from ColumnTemplateBase Since: ArcGIS Maps SDK for JavaScript 4.30 ColumnTemplateBase since 4.24, formatFunction added at 4.30.

Custom function for rendering cell content that is called when the column is rendered in the table. The function should return the formatted content to display within a table's cell. This can be a string, number, an HTML element, or equivalent node type (e.g. a Calcite component). If the content is an HTML element, it is appended to the root element. If the content is a string or number, it is set as the innerHTML of the root element. This property is useful when you want to customize the cell content. For example, you can use this property to create a custom cell renderer that displays a progress bar in the cell. The progress bar can be used to show the progress of a task.

Example

// The following example demonstrates how to use the formatFunction property to create a custom cell renderer that displays a progress bar in the cell. The progress bar can be used to show the progress of a task.
columnTemplate.formatFunction = ({ column, feature, index, value })=> {
  const progress = document.createElement("progress");
  progress.max = 100;
  progress.value = value;
  return progress;
};

frozen Inherited Property frozen Booleanreadonly Inherited from ColumnTemplateBase

Indicates if the the column is frozen in place at the beginning of the table. Column must be first in the FeatureTable's column's, or next to other frozen columns.

Default Value:false

frozenToEnd Inherited Property frozenToEnd Booleanreadonly Inherited from ColumnTemplateBase Since: ArcGIS Maps SDK for JavaScript 4.30 ColumnTemplateBase since 4.24, frozenToEnd added at 4.30.

Indicates if the column is frozen in place at the end of the table. Column must be last in the FeatureTable's column's, or next to other columns with frozenToEnd set to true.

Default Value:false

icon Inherited Property icon String Inherited from ColumnTemplateBase Since: ArcGIS Maps SDK for JavaScript 4.30 ColumnTemplateBase since 4.24, icon added at 4.30.

The string value indicating the icon displayed in the header cell of the column.

See also

Calcite Icon Search

initialSortPriority Inherited Property initialSortPriority Number Inherited from ColumnTemplateBase

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
      type: "field",
      fieldName: "ObjectId",
      direction: "asc",
      initialSortPriority: 1, // This field's sort order takes second-highest priority.
    },
    {
      type: "field",
      fieldName: "Name",
      direction: "asc",
      initialSortPriority: 0, // This field's sort order takes the highest priority.
    },
    {
      type: "field",
      fieldName: "Status",
      direction: "asc",
      initialSortPriority: 2 // This field's sort order is prioritized after Name and ObjectId, respectively.
    }]
  }
  container: "tableDiv"
});

invalid Inherited Property invalid Boolean Inherited from ColumnTemplateBase Since: ArcGIS Maps SDK for JavaScript 4.30 ColumnTemplateBase since 4.24, invalid added at 4.30.

Indicates whether the column is in an invalid state.

Default Value:false

label Inherited Property label String Inherited from ColumnTemplateBase

The default label displayed in the column header cell.

menuConfig Inherited Property menuConfig ColumnTableMenuConfig Inherited from ColumnTemplateBase Since: ArcGIS Maps SDK for JavaScript 4.30 ColumnTemplateBase since 4.24, menuConfig added at 4.30.

Configuration options for the column menu.

Prior to version 4.30, menuConfig was of type ButtonMenuConfig. With the necessary changes needed to move to a more flexible menu system, ButtonMenuConfig has been deprecated in favor of ColumnTableMenuConfig.

required Property required Boolean

Indicates whether a field requires a value.

Default Value:false

resizable Inherited Property resizable Boolean Inherited from ColumnTemplateBase Since: ArcGIS Maps SDK for JavaScript 4.30 ColumnTemplateBase since 4.24, resizable added at 4.30.

Indicates whether the column is resizable.

Default Value:true

sortable Inherited Property sortable Boolean Inherited from ColumnTemplateBase

Indicates whether the column can be sorted. Columns based on custom content will not be sortable.

Default Value:false

textAlign Inherited Property textAlign String Inherited from ColumnTemplateBase

Aligns the columns cell content horizontally.

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

Default Value:"start"

textWrap Inherited Property textWrap Boolean Inherited from ColumnTemplateBase

Indicates cell content should be wrapped and displayed on multiple lines within the cell.

This causes rows to expand when tall content is visible in the viewport. Scrolling tall cells into the viewport may cause the table to visually jump depending on the height of the expanding rows.

Default Value:false

timeZone Inherited Property timeZone String Inherited from ColumnTemplateBase Since: ArcGIS Maps SDK for JavaScript 4.31 ColumnTemplateBase since 4.24, timeZone added at 4.31.

The time zone of the specific column.

See also

MapView.timeZone

type Property type Stringreadonly

The type of column that the template represents.

For ColumnTemplate the type is always "column".

visible Inherited Property visible Boolean Inherited from ColumnTemplateBase

Indicates whether the column is visible.

Default Value:true

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
*	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	ColumnTemplateBase
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.	ColumnTemplateBase

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.

fromJSON Inherited 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 Inherited Method toJSON(){Object} Inherited from ColumnTemplateBase

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.