ColumnTemplateBase

AMD: require(["esri/widgets/FeatureTable/support/ColumnTemplateBase"], (ColumnTemplateBase) => { /* code goes here */ });
ESM: import ColumnTemplateBase from "@arcgis/core/widgets/FeatureTable/support/ColumnTemplateBase.js";
Class: esri/widgets/FeatureTable/support/ColumnTemplateBase
Inheritance: ColumnTemplateBase Accessor
Since: ArcGIS Maps SDK 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.

See also

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

Indicates if the column width will automatically adjust to account for large content.

ColumnTemplateBase

The name of the class.

Accessor

Controls the sort order of the column.

ColumnTemplateBase

The unique field name as defined by the data source.

ColumnTemplateBase

Controls the flex-grow property for the column.

ColumnTemplateBase

Custom function for rendering cell content that is called when the column is rendered in the table.

ColumnTemplateBase

Indicates if the the column is frozen in place at the beginning of the table.

ColumnTemplateBase

Indicates if the column is frozen in place at the end of the table.

ColumnTemplateBase

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

ColumnTemplateBase

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

ColumnTemplateBase

Indicates whether the column is in an invalid state.

ColumnTemplateBase

The default label displayed in the column header cell.

ColumnTemplateBase

Configuration options for the column menu.

ColumnTemplateBase

Indicates whether the column is resizable.

ColumnTemplateBase

Indicates whether the column can be sorted.

ColumnTemplateBase

Aligns the columns cell content horizontally.

ColumnTemplateBase

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

ColumnTemplateBase

The 'type' of column that the template represents.

ColumnTemplateBase

Indicates whether the column is visible.

ColumnTemplateBase

Default width of the column in pixels.

width

Property Details

autoWidth

Property
autoWidth Boolean
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.

direction

Property
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 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"

fieldName

Property
fieldName String

The unique field name as defined by the data source.

flexGrow

Property
flexGrow Number
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

Property
formatFunction FormatFunction
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

Property
frozen Booleanreadonly

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

Property
frozenToEnd Booleanreadonly
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

Property
icon String
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.

initialSortPriority

Property
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.

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

Property
invalid Boolean
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

Property
label String

The default label displayed in the column header cell.

Property
menuConfig ColumnTableMenuConfig
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.

resizable

Property
resizable Boolean
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

Property
sortable Boolean

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

Default Value:false

textAlign

Property
textAlign String

Aligns the columns cell content horizontally.

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

Default Value:"start"

textWrap

Property
textWrap Boolean

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

type

Property
type Stringreadonly

The 'type' of column that the template represents.

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

visible

Property
visible Boolean

Indicates whether the column is visible.

Default Value:true

width

Property
width Number |Stringinner
Since: ArcGIS Maps SDK for JavaScript 4.30 width since 4.24, width added at 4.30.

Default width of the column in pixels.

Default Value:200

Method Overview

Show inherited methods Hide inherited methods
Name 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

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

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

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.

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