require(["esri/widgets/FeatureTable/support/FieldColumnTemplate"], (FieldColumnTemplate) => { /* code goes here */ });
import FieldColumnTemplate from "@arcgis/core/widgets/FeatureTable/support/FieldColumnTemplate.js";
esri/widgets/FeatureTable/support/FieldColumnTemplate
A FieldColumnTemplate formats and defines the structure of a FieldColumn 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 field and/or group column templates.
- See also
const fieldColumnTemplate = new FieldColumnTemplate({
fieldName: "full_name",
label: "Full name",
direction: "asc", // In order to use initialSortPriority, make sure direction is set
initialSortPriority: 0 // This field's sort order takes the highest priority.
});
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
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 coded value domain or a range domain of the associated field. | FieldColumnTemplate | ||
Indicates whether the field is editable. | FieldColumnTemplate | ||
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. | FieldColumnTemplate | ||
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 a field requires a value. | FieldColumnTemplate | ||
Indicates whether the column is resizable. | ColumnTemplateBase | ||
Indicates whether the field column can be sorted. | FieldColumnTemplate | ||
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. | FieldColumnTemplate | ||
Indicates whether the column is visible. | ColumnTemplateBase |
Property Details
-
autoWidth
InheritedPropertyautoWidth Boolean
Inherited from ColumnTemplateBaseSince: ArcGIS Maps SDK for JavaScript 4.30ColumnTemplateBase 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
istrue
.- Default Value:false
-
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"
-
domain
domain CodedValueDomain |RangeDomainautocast
-
The coded value domain or a range domain of the associated field.
-
editable
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.
- Field - This is derived
from the FeatureLayer or SceneLayer. It takes what is set in the
Field.editable property. This
must always be
-
fieldName
InheritedPropertyfieldName String
Inherited from ColumnTemplateBase -
The unique field name as defined by the data source.
-
flexGrow
InheritedPropertyflexGrow Number
Inherited from ColumnTemplateBaseSince: ArcGIS Maps SDK for JavaScript 4.30ColumnTemplateBase 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
formatFunction FieldValueFormatFunction
Since: ArcGIS Maps SDK for JavaScript 4.30FieldColumnTemplate since 4.24, formatFunction added at 4.30. -
Custom function for rendering cell content. Accepts a string, number, an HTML element or equivalent node type (e.g. a Calcite component).
-
frozen
InheritedPropertyfrozen 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
InheritedPropertyfrozenToEnd Booleanreadonly
Inherited from ColumnTemplateBaseSince: ArcGIS Maps SDK for JavaScript 4.30ColumnTemplateBase 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 totrue
.- Default Value:false
-
icon
InheritedPropertyicon String
Inherited from ColumnTemplateBaseSince: ArcGIS Maps SDK for JavaScript 4.30ColumnTemplateBase since 4.24, icon added at 4.30. -
The string value indicating the icon displayed in the header cell of the column.
- See also
-
initialSortPriority
InheritedPropertyinitialSortPriority 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 theStatus
column to the highest priority. This would also occur if manually sorting via the column's UI.- Default Value:null
- See also
Exampleconst 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
InheritedPropertyinvalid Boolean
Inherited from ColumnTemplateBaseSince: ArcGIS Maps SDK for JavaScript 4.30ColumnTemplateBase since 4.24, invalid added at 4.30. -
Indicates whether the column is in an invalid state.
- Default Value:false
-
label
InheritedPropertylabel String
Inherited from ColumnTemplateBase -
The default label displayed in the column header cell.
-
menuConfig
InheritedPropertymenuConfig ColumnTableMenuConfig
Inherited from ColumnTemplateBaseSince: ArcGIS Maps SDK for JavaScript 4.30ColumnTemplateBase since 4.24, menuConfig added at 4.30. -
Configuration options for the column menu.
Prior to version 4.30,
menuConfig
was of typeButtonMenuConfig
. With the necessary changes needed to move to a more flexible menu system,ButtonMenuConfig
has been deprecated in favor of ColumnTableMenuConfig.
-
required
required Boolean
-
Indicates whether a field requires a value.
- Default Value:false
-
resizable
InheritedPropertyresizable Boolean
Inherited from ColumnTemplateBaseSince: ArcGIS Maps SDK for JavaScript 4.30ColumnTemplateBase since 4.24, resizable added at 4.30. -
Indicates whether the column is resizable.
- Default Value:true
-
sortable
sortable Boolean
-
Indicates whether the field column can be sorted.
- Default Value:true
-
textAlign
InheritedPropertytextAlign String
Inherited from ColumnTemplateBase -
Aligns the columns cell content horizontally.
Possible Values:"start" |"center" |"end"
- Default Value:"start"
-
textWrap
InheritedPropertytextWrap 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
-
type
type Stringreadonly
-
The 'type' of column that the template represents.
This property must be set to
field
when creating a new FieldColumnTemplate within a TableTemplate.For FieldColumnTemplate the type is always "field".
-
visible
InheritedPropertyvisible Boolean
Inherited from ColumnTemplateBase -
Indicates whether the column is visible.
- Default Value:true
Method Overview
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
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
-
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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
InheritedMethodtoJSON(){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.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.
Type Definitions
-
FieldValueFormatFunction
FieldValueFormatFunction(params){String |Number |HTMLElement |null}
-
Custom function for rendering cell content. Accepts a string, number, an HTML element or equivalent node type (e.g. a Calcite component).
ParametersSpecificationparams ObjectAn object containing information about the associated row and feature.
Specificationcolumn esri/widgets/FeatureTable/ColumnA reference to this specific Column.
feature GraphicA reference to the feature represented by the associated row.
field FieldA reference to the field represented by the column.
index NumberIndex of the associated row being rendered.
Current projected value of the cell.
ReturnsType Description String | Number | HTMLElement | null Formatted content to be displayed in the cell.