FieldColumn

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

Type	Summary	Class
String	more details The display name for the field.	more details	FieldColumn
FieldColumnConfig	more details The field configuration for the column.	more details	FieldColumn
String	more details The name of the class.	more details	Accessor
Number\|String\|null\|undefined	more details The default value set for the field.	more details	FieldColumn
String	more details Contains information describing the purpose of each field.	more details	FieldColumn
String\|null	more details Controls the sort order of the column.	more details	FieldColumn
Boolean	more details Indicates whether the field is editable.	more details	FieldColumn
Field	more details The Field associated with this column.	more details	FieldColumn
FeatureLayer\|SceneLayer	more details If applicable, the associated FeatureLayer or SceneLayer tied to the column.	more details	FieldColumn
Number	more details Restricts the input length for the column.	more details	FieldColumn
ButtonMenu	more details The object to customize the feature table column's menu content.	more details	FieldColumn
ButtonMenuConfig	more details The Object used to customize the column's menu content.	more details	FieldColumn
String	more details The name of the field.	more details	FieldColumn
Boolean	more details Indicates if the field can accept `null` values.	more details	FieldColumn
Boolean	more details Indicates whether the field is required.	more details	FieldColumn
Boolean	more details Indicates whether the column is resizable.	more details	FieldColumn
Boolean	more details Indicates whether the field is sortable.	more details	FieldColumn

Property Details

alias Stringreadonly

The display name for the field.

config FieldColumnConfig

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.

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.

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 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 overriden using a field column configuration.
Config - The editable permissions on a field can be configured by setting the editable property of the FieldColumnConfig.
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 configuration 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 Field

The Field associated with this column.

layer FeatureLayer|SceneLayer

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

maxLength Numberreadonly

Restricts the input length for the column.

menu ButtonMenureadonly

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

See also:

menuConfig ButtonMenuConfigreadonly

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

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

Name	Return Type	Summary	Class
	ButtonMenuItemConfig	more details Returns any associated menu items on the column.	more details	FieldColumn

Method Details

getMenuItems(){ButtonMenuItemConfig}

Returns any associated menu items on the column.

Returns:

Type	Description
ButtonMenuItemConfig	The menu items associated with the column.

ArcGIS API for JavaScriptAPI Reference

Was this page helpful?

Was this page helpful?