FieldColumn

AMD: require(["esri/widgets/FeatureTable/FieldColumn"], (FieldColumn) => { /* code goes here */ });
ESM: import FieldColumn from "@arcgis/core/widgets/FeatureTable/FieldColumn";
Class: esri/widgets/FeatureTable/FieldColumn
Inheritance: FieldColumn Accessor
Since: ArcGIS API for JavaScript 4.16

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.

See also

Constructors

new FieldColumn(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
Name Type Summary Class
String

The display name for the field.

more details
FieldColumn
FieldColumnConfig

The field configuration for the column.

more details
FieldColumn
String

The name of the class.

more details
Accessor
Number|String|null|undefined

The default value set for the field.

more details
FieldColumn
String

Contains information describing the purpose of each field.

more details
FieldColumn
Boolean

Indicates whether the field is editable.

more details
FieldColumn
Field

The Field associated with this column.

more details
FieldColumn
FeatureLayer|SceneLayer

If applicable, the associated FeatureLayer or SceneLayer tied to the column.

more details
FieldColumn
Number

Restricts the input length for the column.

more details
FieldColumn
ButtonMenu

The object to customize the feature table column's menu content.

more details
FieldColumn
ButtonMenuConfig

The Object used to customize the column's menu content.

more details
FieldColumn
Number

Restricts the input length for the column.

more details
FieldColumn
String

The name of the field.

more details
FieldColumn
Boolean

Indicates if the field can accept null values.

more details
FieldColumn
Boolean

Indicates whether the field is required.

more details
FieldColumn
Boolean

Indicates whether the column is resizable.

more details
FieldColumn
Boolean

Indicates whether the field is sortable.

more details
FieldColumn

Property Details

alias Stringreadonly

The display name for the field.

Deprecated since version 4.24. Use FieldColumnTemplate via the FeatureTable's tableTemplate.

The field configuration for the column.

declaredClass Stringreadonly inherited

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

defaultValue Number|String|null|undefinedreadonly

The default value set for the field.

description Stringreadonly

Contains information describing the purpose of each field.

editable Booleanreadonly

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

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

The Field associated with this column.

If applicable, the associated FeatureLayer or SceneLayer tied to the column.

maxLength Numberreadonly

Restricts the input length for the column.

The object to customize the feature table column's menu content.

See also

The Object used to customize the column's menu content.

minLength Numberreadonly

Restricts the input length for the column.

name Stringreadonly

The name of the field.

nullable Booleanreadonly

Indicates if the field can accept null values.

required Booleanreadonly

Indicates whether the field is required.

resizable Booleanreadonly

Indicates whether the column is resizable.

Default Value:true
sortable Booleanreadonly

Indicates whether the field is sortable.

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.

more details
Accessor
ButtonMenuItemConfig

Returns any associated menu items on the column.

more details
FieldColumn
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API for JavaScript 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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.

getMenuItems(){ButtonMenuItemConfig}

Returns any associated menu items on the column.

Returns
Type Description
ButtonMenuItemConfig The menu items associated with the column.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 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(groupKey)inherited
Since: ArcGIS API for JavaScript 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");

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