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. It is designed primarily to read and not interact directly with the columns.
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 |
---|---|---|---|
String | The display name for the field. | FieldColumn | |
String | The name of the class. | Accessor | |
Number|String|null|undefined | The default value set for the field. | FieldColumn | |
String | Contains information describing the purpose of each field. | FieldColumn | |
Boolean | Indicates whether the field is editable. | FieldColumn | |
Field | The Field associated with this column. | FieldColumn | |
Boolean | Used to indicate the column is in an invalid state. | FieldColumn | |
FeatureLayer|SceneLayer | If applicable, the associated FeatureLayer or SceneLayer tied to the column. | FieldColumn | |
Number | Restricts the input length for the column. | FieldColumn | |
ButtonMenu | The object to customize the feature table column's menu content. | FieldColumn | |
ButtonMenuConfig | The Object used to customize the column's menu content. | FieldColumn | |
Number | Restricts the input length for the column. | FieldColumn | |
String | The name of the field. | FieldColumn | |
Boolean | Indicates if the field can accept | FieldColumn | |
Boolean | Indicates whether the field is required. | FieldColumn | |
Boolean | Indicates whether the column is resizable. | FieldColumn | |
Boolean | Indicates whether the column is sortable. | FieldColumn | |
FieldColumnTemplate | A configurable template for the table column. | FieldColumn |
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.
-
editable
editable Booleanreadonly
-
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
-
invalid
invalid Boolean
-
Used to indicate the column is in an invalid state.
- Default Value:undefined
-
layer
layer FeatureLayer|SceneLayer
-
If applicable, the associated FeatureLayer or SceneLayer tied to the column.
-
maxLength
maxLength Numberreadonly
-
Restricts the input length for the column.
-
menu
menu ButtonMenureadonly
-
The object to customize the feature table column's menu content.
- See also
-
menuConfig
menuConfig ButtonMenuConfigreadonly
-
The Object used to customize the column's menu content.
-
minLength
minLength Numberreadonly
-
Restricts the input length for the column.
-
name
name Stringreadonly
-
The name of the field.
-
nullable
nullable Booleanreadonly
-
Indicates if the field can accept
null
values.
-
required
required Booleanreadonly
-
Indicates whether the field is required.
-
resizable
resizable Booleanreadonly
-
Indicates whether the column is resizable.
- Default Value:true
-
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.
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
ButtonMenuItemConfig | Returns any associated menu items on the column. | FieldColumn | |
Boolean | Returns true if a named group of handles exist. | Accessor | |
Removes a group of handles owned by the object. | Accessor |
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.
-
getMenuItems
getMenuItems(){ButtonMenuItemConfig}
-
Returns any associated menu items on the column.
ReturnsType Description ButtonMenuItemConfig The menu items associated with the column.
-
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");