require(["esri/widgets/FeatureTable/FieldColumn"], (FieldColumn) => { /* code goes here */ });
import FieldColumn from "@arcgis/core/widgets/FeatureTable/FieldColumn.js";
esri/widgets/FeatureTable/FieldColumn
The FieldColumn class works with the FeatureTable and provides the underlying logic for column behavior.
This class should be used for observing potential changes. Any configuration and changes to the field columns should be done handled via the TableTemplate and the FieldColumnTemplate class.
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 |
---|---|---|---|
The display name for the field. | FieldColumn | ||
Indicates if the column width will automatically adjust to account for large content. | Column | ||
The name of the class. | Accessor | ||
The default value set for the field. | FieldColumn | ||
Contains information describing the purpose of each field. | FieldColumn | ||
Controls the sort order of the column. | Column | ||
Indicates whether the field is editable. | FieldColumn | ||
The sanitized label string safe for display in the header cell. | Column | ||
The Field associated with this column. | FieldColumn | ||
The unique field name as defined by the data source. | Column | ||
Controls the flex-grow property for the column. | Column | ||
Custom function for rendering cell content that is called when the column is rendered in the table. | FieldColumn | ||
Indicates if the the column is frozen in place at the beginning of the table. | Column | ||
Indicates if the column is frozen in place at the end of the table. | Column | ||
The string value indicating the icon displayed in the header cell of the column. | Column | ||
Indicates the initial sort priority of the column when first rendered. | Column | ||
Indicates whether the column is in an invalid state. | Column | ||
The default label displayed in the column header cell. | Column | ||
If applicable, the associated FeatureLayer or SceneLayer tied to the field column. | FieldColumn | ||
Restricts the input length for the column. | FieldColumn | ||
The element representing the field column's menu. | Column | ||
Configuration options for the column's menu. | Column | ||
Indicates whether the Column's menu is currently open. | Column | ||
Indicates whether the Column's menu will be displayed. | Column | ||
Restricts the input length for the column. | FieldColumn | ||
The name of the field. | FieldColumn | ||
Indicates if the field can accept | FieldColumn | ||
Indicates whether a value is required when editing feature attributes within the table's cell. | FieldColumn | ||
Indicates whether the column is resizable. | Column | ||
Indicates whether the column is sortable. | FieldColumn | ||
A configurable template for the table column. | FieldColumn | ||
Aligns the columns cell content horizontally. | Column | ||
Indicates cell content should be wrapped and displayed on multiple lines within the cell. | Column | ||
The storage IANA time zone of the column. | Column | ||
The visible elements of the column's associated FeatureTable. | Column | ||
Width of the column in pixels. | Column |
Property Details
-
alias
alias Stringreadonly
-
The display name for the field.
-
The default value set for the field.
-
description
description Stringreadonly
-
Contains information describing the purpose of each field.
-
Inherited from Column
-
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"
-
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.
- See also
- Field - This is derived
from the FeatureLayer or SceneLayer. It takes what is set in the
Field.editable property. This
must always be
-
formatFunction
formatFunction FieldValueFormatFunction
-
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. If the content is
null
, the root element is cleared. If the content isundefined
, the root element is not modified. 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.
-
layer
layer FeatureLayer |SceneLayer
-
If applicable, the associated FeatureLayer or SceneLayer tied to the field column.
-
maxLength
maxLength Numberreadonly
-
Restricts the input length for the column.
-
menu
InheritedPropertymenu HTMLElementreadonly
Inherited from Column -
The element representing the field column's menu.
-
menuConfig
InheritedPropertymenuConfig ColumnTableMenuConfigreadonly
Inherited from Column -
Configuration options for the column's menu.
-
minLength
minLength Numberreadonly
-
Restricts the input length for the column.
-
name
name Stringreadonly
Deprecated since version 4.30, use FieldColumn.fieldName instead. -
The name of the field.
-
nullable
nullable Booleanreadonly
-
Indicates if the field can accept
null
values.
-
required
required Boolean
-
Indicates whether a value is required when editing feature attributes within the table's cell.
-
sortable
sortable Boolean
-
Indicates whether the column is sortable.
- Default Value:true
-
template
template FieldColumnTemplate
Since: ArcGIS Maps SDK for JavaScript 4.28FieldColumn since 4.16, template added at 4.28. -
A configurable template for the table column. The template allows for customizing the appearance of the column. Once the template is set, it will override the default appearance and will remain as such once the table is created. Any information regarding the column's current state can be accessed using the Column class.
Templates should be used primarily for initial column configuration and should not be used for observing changes.
-
textWrap
InheritedPropertytextWrap Boolean
Inherited from Column -
Indicates cell content should be wrapped and displayed on multiple lines within the cell. Warning: 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
InheritedPropertytimeZone Stringreadonly
Inherited from Column -
The storage IANA time zone of the column.
-
visibleElements
InheritedPropertyvisibleElements VisibleElements
Inherited from Column -
The visible elements of the column's associated FeatureTable.
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Convenience method for closing the column menu. | Column | ||
Emits an event on the instance. | Column | ||
Indicates whether there is an event listener on the instance that matches the provided event name. | Column | ||
Returns true if a named group of handles exist. | Accessor | ||
Registers an event handler on the instance. | Column | ||
Convenience method for opening the column menu. | Column | ||
Removes a group of handles owned by the object. | Accessor | ||
Convenience method for sorting the current column. | Column |
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.
-
Inherited from Column
-
Convenience method for closing the column menu.
-
hasEventListener
InheritedMethodhasEventListener(type){Boolean}
Inherited from Column -
Indicates whether there is an event listener on the instance that matches the provided event name.
Parametertype StringThe name of the event.
ReturnsType Description Boolean Returns true if the class supports the input event.
-
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"); }
-
on
InheritedMethodon(type, listener){Object}
Inherited from Column -
Registers an event handler on the instance. Call this method to hook an event with a listener.
ParametersReturnsType Description Object Returns an event handler with a remove()
method that should be called to stop listening for the event(s).Property Type Description remove Function When called, removes the listener from the event. Exampleview.on("click", function(event){ // event is the event handle returned after the event fires. console.log(event.mapPoint); });
-
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");
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.
SpecificationReturnsType Description String | Number | HTMLElement | null Formatted content to be displayed in the cell.