FeatureTable

This widget provides an interactive tabular view of each feature's attributes in a feature layer. In addition, it also works with standalone tables that are not associated with underlying geometries. When working with a large dataset, the table loads additional features as the user scrolls.

Known Limitations

Number and date formatting is not yet supported but will be added in a future release.
Viewing related records is currently not supported.
Viewing attachments is currently not supported, although if a feature contains attachments, the total count per feature will display.
SceneLayers are supported only starting with version 4.20. SceneLayer are only supported if they have an associated FeatureLayer.

The following image displays the standalone FeatureTable widget without any associated map.

standalone featuretable widget

The following image displays the FeatureTable widget with an associated map.

standalone featuretable widget

See also:

Constructors

new FeatureTable(properties)

Parameter:

properties Object

optional

See the properties for a list of all the properties that may be passed into the constructor.

Example:

// Typical usage for FeatureTable widget. This will recognize all fields in the layer if none are set.
const featureTable = new FeatureTable({
  view: view, // The view property must be set for the select/highlight to work
  layer: featureLayer,
  container: "tableDiv"
});

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
Boolean	more details Indicates whether to display the `Attachments` field in the table.	more details	FeatureTable
Boolean	more details When `true`, columns can be reordered by dragging a column's header.	more details	FeatureTable
Collection<FieldColumn>	more details A collection of columns within the table.	more details	FeatureTable
String\|HTMLElement	more details The ID or node representing the DOM element containing the widget.	more details	Widget
String	more details The name of the class.	more details	Accessor
Boolean	more details Indicates whether editing is enabled on the data within the feature table.	more details	FeatureTable
FieldColumnConfig []	more details An array of individual field configuration objects.	more details	FeatureTable
Geometry	more details Set this property to filter the features displayed in the table.	more details	FeatureTable
Boolean	more details Indicates whether to highlight the associated feature when a row is selected.	more details	FeatureTable
String	more details The unique ID assigned to the widget when the widget is created.	more details	Widget
String	more details The widget's default label.	more details	FeatureTable
FeatureLayer\|SceneLayer\|GeoJSONLayer\|CSVLayer\|WFSLayer\|ImageryLayer	more details The associated FeatureLayer, SceneLayer, GeoJSONLayer, CSVLayer, ImageryLayer, or WFSLayer containing the fields and attributes to display within the widget.	more details	FeatureTable
ButtonMenu	more details Reference to the FeatureTable's primary menu.	more details	FeatureTable
ButtonMenuConfig	more details Set this object to customize the feature table's menu content.	more details	FeatureTable
Number	more details The default page size used when displaying features within the table.	more details	FeatureTable
MapView	more details A reference to the MapView.	more details	FeatureTable
FeatureTableViewModel	more details The view model for this widget.	more details	FeatureTable
Boolean	more details Indicates whether the widget is visible.	more details	Widget
VisibleElements	more details The visible elements that are displayed within the widget.	more details	FeatureTable

Property Details

attachmentsEnabled Boolean

Indicates whether to display the Attachments field in the table. This is only applicable if the feature layer supports attachments. Currently, this field only displays the count of attachments per feature.

featuretable attachmentsEnabled

Default Value:false

columnReorderingEnabled Boolean Since: ArcGIS API for JavaScript 4.16

When true, columns can be reordered by dragging a column's header.

Default Value:true

columns Collection<FieldColumn>autocast Autocasts from Object [] Since: ArcGIS API for JavaScript 4.16

A collection of columns within the table.

container String|HTMLElement inherited

The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use cases when working with widgets.

Examples:

// Create the HTML div element programmatically at runtime and set to the widget's container
const basemapGallery = new BasemapGallery({
  view: view,
  container: document.createElement("div")
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// Specify an already-defined HTML div element in the widget's container

const basemapGallery = new BasemapGallery({
  view: view,
  container: basemapGalleryDiv
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// HTML markup
<body>
  <div id="viewDiv"></div>
  <div id="basemapGalleryDiv"></div>
</body>

// Specify the widget while adding to the view's UI
const basemapGallery = new BasemapGallery({
  view: view
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

declaredClass Stringreadonly inherited

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

editingEnabled Boolean Since: ArcGIS API for JavaScript 4.16

Indicates whether editing is enabled on the data within the feature table. Double-clicking in a cell will enable editing for that value.

Editing permissions can be broken down with the following levels of priority:

Field - This is derived from the FeatureLayer. 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.

featuretable editing

Default Value:false

See also:

Sample - FeatureTable with editing enabled

fieldConfigs FieldColumnConfig []autocast

An array of individual field configuration objects. This is where you can specify what fields to display and how you wish to display them.

When not set, all fields except for CreationDate, Creator, EditDate, Editor, and GlobalID will be included. Otherwise, it is up to the developer to set the right field(s) to override and display.

Default Value:null

filterGeometry Geometryautocast Since: ArcGIS API for JavaScript 4.19

Set this property to filter the features displayed in the table. It accepts a Geometry, e.g. Extent, and uses it as a spatial filter. When modifying this property, the FeatureTable will completely refresh and re-query for all features.

See also:

Sample - FeatureTable widget using a map

Example:

// Filter the table to only display the associated feature(s) that fall within the filterGeometry's geometry, (e.g. Extent)
featureLayer.watch("loaded", () => {
  watchUtils.whenFalse(view, "updating", () => {
    // Get the new extent of view/map whenever map is updated
    if (view.extent) {
      // Filter and show only the visible features in the feature table
      featureTable.filterGeometry = view.extent;
    }
  });
});

highlightOnRowSelectEnabled Boolean Since: ArcGIS API for JavaScript 4.16

Indicates whether to highlight the associated feature when a row is selected.

Default Value:true

id String inherited

The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.

label String

The widget's default label.

The associated FeatureLayer, SceneLayer, GeoJSONLayer, CSVLayer, ImageryLayer, or WFSLayer containing the fields and attributes to display within the widget. The table's pagination defaults to 50 records at a time. If the layer contains less than 50 records, it will use whatever count it has. Note that 0 records do not apply.

Support for GeoJSONLayer, CSVLayer, ImageryLayer, and WFSLayer was added at version 4.21.
For an ImageryLayer to work with FeatureTable, it must have mosaic dataset. Currently, Map and FeatureTable interaction with ImageryLayers is not supported.

menu ButtonMenureadonly Since: ArcGIS API for JavaScript 4.19

Reference to the FeatureTable's primary menu.

The menu's items are regenerated when a column's visibility changes. Use the FeatureTable's menuConfig and menuConfig.items to customize menu items. These options are recommended, rather than updating The table's items directly off of its menu. This helps ensure the menu always shows the correct items.

See also:

menuConfig ButtonMenuConfig Since: ArcGIS API for JavaScript 4.16

Set this object to customize the feature table's menu content.

See also:

pageSize Number Since: ArcGIS API for JavaScript 4.19

The default page size used when displaying features within the table. By default, the page loads the first 50 features returned by the service.

It is not possible to overwrite the maximum page size on the server, ie. maxRecordCount, as this property only applies to set values less than the maximum page size, i.e. maxRecordCount, set on the service.

Default Value:50

See also:

ArcGIS REST API - FeatureLayer - maxRecordCount

view MapView

A reference to the MapView. This property must be set for select/highlighting in the map to work.

viewModel FeatureTableViewModelautocast

The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the FeatureTableViewModel class to access all properties and methods on the widget.

visible Boolean inherited

Indicates whether the widget is visible.

If false, the widget will no longer be rendered in the web document. This may affect the layout of other elements or widgets in the document. For example, if this widget is the first of three widgets associated to the upper right hand corner of the view UI, then the other widgets will reposition when this widget is made invisible. For more information, refer to the CSS display value of "none".

Default Value:true

Example:

// Hides the widget in the view
widget.visible = false;

visibleElements VisibleElementsautocast

The visible elements that are displayed within the widget. This property provides the ability to turn individual elements of the widget's display on/off.

Example:

featureTable.visibleElements = {
   header: true,
   menu: true,
   menuItems: {
     clearSelection: true,
     refreshData: false,
     toggleColumns: false
   },
   selectionColumn: false
}

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
String	more details A utility method used for building the value for a widget's `class` property.	more details	Widget
	more details This clears any highlighted features.	more details	FeatureTable
	more details Clears the current selection within the table.	more details	FeatureTable
	more details Unselects the specified rows within the table.	more details	FeatureTable
	more details Destroys the widget instance.	more details	Widget
Boolean	more details Emits an event on the instance.	more details	Widget
FieldColumn	more details Finds the specified column within the feature table.	more details	FeatureTable
Boolean	more details Indicates whether there is an event listener on the instance that matches the provided event name.	more details	Widget
	more details Hides the specified column from the feature table.	more details	FeatureTable
Boolean	more details `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).	more details	Widget
Boolean	more details `isRejected()` may be used to verify if creating an instance of the class is rejected.	more details	Widget
Boolean	more details `isResolved()` may be used to verify if creating an instance of the class is resolved.	more details	Widget
Object	more details Registers an event handler on the instance.	more details	Widget
	more details Widget teardown helper.	more details	Widget
	more details This method is primarily used by developers when implementing custom widgets.	more details	Widget
	more details Refreshes the table contents.	more details	FeatureTable
Object	more details This method is primarily used by developers when implementing custom widgets.	more details	Widget
	more details Renders widget to the DOM immediately.	more details	Widget
	more details This method is primarily used by developers when implementing custom widgets.	more details	Widget
	more details Scrolls the table to a row based on specified index.	more details	FeatureTable
	more details Selects the specified rows within the table.	more details	FeatureTable
	more details Shows all the columns in the table.	more details	FeatureTable
	more details Shows the specified column within the feature table.	more details	FeatureTable
	more details Sorts the column.	more details	FeatureTable
Promise	more details `when()` may be leveraged once an instance of the class is created.	more details	Widget

Method Details

classes(classNames){String}inherited

A utility method used for building the value for a widget's class property. This aids in simplifying CSS class setup.

Parameter:

classNames String|String []|Object

repeatable

The class names.

Returns:

Type	Description
String	The computed class name.

See also:

Guide - Widget development (rendering)

Example:

// .tsx syntax showing how to set CSS classes while rendering the widget

render() {
  const dynamicIconClasses = {
    [CSS.myIcon]: this.showIcon,
    [CSS.greyIcon]: !this.showIcon
  };

  return (
    <div class={classes(CSS.root, CSS.mixin, dynamicIconClasses)} />
  );
}

clearHighlights() Since: ArcGIS API for JavaScript 4.16

This clears any highlighted features. Take note that the associated rows are not deselected.

clearSelection() Since: ArcGIS API for JavaScript 4.16

Clears the current selection within the table.

deselectRows(params) Since: ArcGIS API for JavaScript 4.16

Unselects the specified rows within the table.

Parameter:

params Number|Graphic|Array<(number|Graphic)>

The selection parameters to deselect within the feature table.

See also:

Sample - FeatureTable with popup interaction

destroy()inherited

Destroys the widget instance.

emit(type, event){Boolean}inherited

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters:

type String

The name of the event.

event Object

optional

The event payload.

Returns:

Type	Description
Boolean	`true` if a listener was notified

findColumn(fieldName){FieldColumn} Since: ArcGIS API for JavaScript 4.16

Finds the specified column within the feature table.

Parameter:

fieldName String

The fieldName of the column to find.

Returns:

Type	Description
FieldColumn	The returned column from the table.

hasEventListener(type){Boolean}inherited

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter:

type String

The name of the event.

Returns:

Type	Description
Boolean	Returns true if the class supports the input event.

hideColumn(fieldName) Since: ArcGIS API for JavaScript 4.16

Hides the specified column from the feature table.

Parameter:

fieldName String

The fieldName of the column to hide.

isFulfilled(){Boolean}inherited Since: ArcGIS API for JavaScript 4.19

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns:

Type	Description
Boolean	Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected(){Boolean}inherited Since: ArcGIS API for JavaScript 4.19

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns:

Type	Description
Boolean	Indicates whether creating an instance of the class has been rejected.

isResolved(){Boolean}inherited Since: ArcGIS API for JavaScript 4.19

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns:

Type	Description
Boolean	Indicates whether creating an instance of the class has been resolved.

on(type, listener){Object}inherited

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters:

type String|String []

An event or an array of events to listen for.

listener Function

The function to call when the event fires.

Returns:

Type 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.

Example:

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

own(handles)inherited

Widget teardown helper. Any handles added to it will be automatically removed when the widget is destroyed.

Parameter:

handles WatchHandle|WatchHandle []

Handles marked for removal once the widget is destroyed.

postInitialize()inherited

This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.

refresh() Since: ArcGIS API for JavaScript 4.16

Refreshes the table contents.

render(){Object}inherited

This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

Returns:

Type	Description
Object	The rendered virtual node.

renderNow()inherited

Renders widget to the DOM immediately.

scheduleRender()inherited

This method is primarily used by developers when implementing custom widgets. Schedules widget rendering. This method is useful for changes affecting the UI.

scrollToIndex() Since: ArcGIS API for JavaScript 4.19

Scrolls the table to a row based on specified index.

selectRows(params) Since: ArcGIS API for JavaScript 4.16

Selects the specified rows within the table.

Parameter:

params Number|Graphic|Array<(number|Graphic)>

The selection parameters to select within the feature table.

See also:

Sample - FeatureTable with popup interaction

showAllColumns() Since: ArcGIS API for JavaScript 4.16

Shows all the columns in the table.

showColumn(fieldName) Since: ArcGIS API for JavaScript 4.16

Shows the specified column within the feature table.

Parameter:

fieldName String

The fieldName of the column to show.

sortColumn(path, direction) Since: ArcGIS API for JavaScript 4.16

Sorts the column.

Possible Values

Value	Description
asc	Sorts the column in ascending order.
desc	Sorts the column in descending order.

Parameters:

path String

The specified field name to sort.

direction String

The direction to sort.

Possible Values:"asc"|"desc"

when(callback, errback){Promise}inherited Since: ArcGIS API for JavaScript 4.19

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters:

callback Function

optional

The function to call when the promise resolves.

errback Function

optional

The function to execute when the promise fails.

Returns:

Type	Description
Promise	Returns a new promise for the result of `callback` that may be used to chain additional functions.

Example:

// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way
let bmGallery = new BasemapGallery();
bmGallery.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

Type Definitions

ButtonMenuConfig

The configurable options to customize either the feature table or column menu via the menuConfig property.

Properties:

container HTMLElement

optional

The DOM Element containing the menu.

iconClass Boolean

optional

Adds a CSS class to the menu button's DOM node.

items ButtonMenuItem []

optional

An array of ButtonMenuItems. The following image shows the default menu with two additional items.

open Boolean

optional

Indicates if the menu content is visible. Default is false.

viewModel ButtonMenuViewModel

optional

The associated viewModel for the ButtonMenu.

See also:

ButtonMenuItemConfig

The configurable options to customize either the feature table or column menu via the menuConfig item property.

Properties:

autoCloseMenu Boolean

optional

Indicates whether to automatically close the menu's item.

clickFunction ButtonMenuItemClickFunction

optional

A function that executes on the ButtonMenuItem's click event.

iconClass String

optional

Adds a CSS class to the menu button's DOM node.

items ButtonMenuItem []

optional

An array of individual menu items.

label String

optional

The label of the menu item. This can be used in conjunction with the iconClass property.

open Boolean

optional

Indicates if the menu content is visible.

selectionEnabled Boolean

optional

Indicates whether a toggled state should be applied to individual menu items.

selected Boolean

optional

Indicates whether the menu item is selected.

See also:

VisibleElements

The visible elements that are displayed within the widget. This provides the ability to turn individual elements of the widget's display on/off.

Properties:

header Boolean

optional

Indicates whether to display the feature table's header information. Default value is true.

menu Boolean

optional

Indicates whether to display the feature table's menu.Default value is true.

selectionColumn Boolean

optional

Indicates whether to display the selection column in the table. Each row has a checkbox that selects its corresponding feature.

menuItems Object

optional

The menu items within the feature table menu. This image shows the individual items within the widget's menu.

featuretable widget menu items

Specification:

clearSelection Boolean

optional

Indicates whether to display the Clear selection menu item. Default value is true.

refreshData Boolean

optional

Indicates whether to display the Refresh data menu item. Default value is true.

toggleColumns toggleColumns

optional

Indicates whether to enable toggling column visibility within the menu. Default value is true.

Event Overview

Name	Type	Summary	Class
	{added: Object [],added.feature: Graphic,added.attachments: AttachmentInfo [],added.relatedRecords: Graphic [],removed: Object [],removed.feature: Graphic,removed.attachments: AttachmentInfo [],removed.relatedRecords: Graphic []}	more details Fires when a row selection is added and/or removed within the FeatureTable.	more details	FeatureTable

Name

Type

Summary

Class

{added: Object[],added.feature: Graphic,added.attachments: AttachmentInfo[],added.relatedRecords: Graphic[],removed: Object[],removed.feature: Graphic,removed.attachments: AttachmentInfo[],removed.relatedRecords: Graphic[]}

more details

Fires when a row selection is added and/or removed within the FeatureTable.

more details

FeatureTable

Event Details

selection-change

Fires when a row selection is added and/or removed within the FeatureTable.

Properties:

added Object []

An array of objects containing row (feature) data added to the table selection.

Specification:

feature Graphic

The associated row (feature) added to the feature table selection.

attachments AttachmentInfo []

If applicable, an array of AttachmentInfo associated with the row (feature) added to the feature table selection.

relatedRecords Graphic []

(Currently not implemented). If applicable, an array of related features associated with the row (feature) added to the feature table selection.

removed Object []

An array of objects containing row (feature) data removed in the table selection.

Specification:

feature Graphic

The associated row (feature) removed from the feature table selection.

attachments AttachmentInfo []

If applicable, an array of AttachmentInfo associated with the row (feature) removed from the feature table selection.

relatedRecords Graphic []

(Currently not implemented). If applicable, an array of related features associated with the row (feature) removed from the feature table selection.

See also:

Example:

// This function will fire each time a row (feature) is either added
// or removed from the feature table's selection
featureTable.on("selection-change", (event) => {
  let addedRows = event.added; // An array of features added to the selection
  let removedRows = event.removed;  // An array of features removed from the selection
});

ArcGIS API for JavaScriptAPI Reference

Was this page helpful?

Was this page helpful?