Skip To ContentArcGIS for DevelopersSign In Dashboard
require(["esri/widgets/FeatureTable"], function(FeatureTable) { /* code goes here */ });
Class: esri/widgets/FeatureTable
Inheritance: FeatureTable Widget Accessor
Since: ArcGIS API for JavaScript 4.15
beta

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

  • Not supported in Internet Explorer 11.
  • 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.
  • Visible features from a map and having only these rows reflected in the table is currently not implemented but will be in an upcoming release. Although it is possible to select rows within the table and have their corresponding feature selected.
  • Currently, if a map feature falls outside what is currently being viewed, it still displays within the feature table. Restricting the rows to match visible features is in current development plans.
  • Dark themed CSS is currently not supported.

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

For information about gaining full control of widget styles, see the Styling topic.
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.
NameTypeSummaryClass
Boolean

Indicates whether to display the Attachments field in the table.

more details
more detailsFeatureTable
Boolean

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

more details
more detailsFeatureTable
Collection<FieldColumn>

A collection of columns within the table.

more details
more detailsFeatureTable
String|HTMLElement

The ID or node representing the DOM element containing the widget.

more details
more detailsWidget
String

The name of the class.

more details
more detailsAccessor
Boolean

Indicates whether editing is enabled on the data within the feature table.

more details
more detailsFeatureTable
FieldColumnConfig[]

An array of individual field configuration objects.

more details
more detailsFeatureTable
Boolean

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

more details
more detailsFeatureTable
String

The unique ID assigned to the widget when the widget is created.

more details
more detailsWidget
String

The widget's default label.

more details
more detailsFeatureTable
FeatureLayer

The associated FeatureLayer containing the fields and attributes to display within the widget.

more details
more detailsFeatureTable
ButtonMenuConfig

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

more details
more detailsFeatureTable
MapView

A reference to the MapView.

more details
more detailsFeatureTable
FeatureTableViewModel

The view model for this widget.

more details
more detailsFeatureTable
VisibleElements

The visible elements that are displayed within the widget.

more details
more detailsFeatureTable

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 attachmentenabled

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
Autocasts from Object[]
Since: ArcGIS API for JavaScript 4.16

A collection of columns within the table.

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:

  1. 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.
  2. Config - The editable permissions on a field can be configured by setting the editable property of the FieldColumnConfig.
  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 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[]

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
highlightOnRowSelectEnabled Boolean
Since: ArcGIS API for JavaScript 4.16

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

Default Value:true

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 containing the fields and attributes to display within the widget.

Since: ArcGIS API for JavaScript 4.16

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

default and custom feature table menus

See also:
view MapView

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

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.

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
   }
}

Method Overview

NameReturn TypeSummaryClass
String

A utility method used for building the value for a widget's class property.

more details
more detailsWidget

This clears any highlighted features.

more details
more detailsFeatureTable

Clears the current selection within the table.

more details
more detailsFeatureTable

Unselects the specified rows within the table.

more details
more detailsFeatureTable

Destroys the widget instance.

more details
more detailsWidget
Boolean

Emits an event on the instance.

more details
more detailsWidget

Finds the specified column within the feature table.

more details
more detailsFeatureTable
Boolean

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

more details
more detailsWidget

Hides the specified column from the feature table.

more details
more detailsFeatureTable
Object

Registers an event handler on the instance.

more details
more detailsWidget

Widget teardown helper.

more details
more detailsWidget

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget

Refreshes the table contents.

more details
more detailsFeatureTable
Object

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget

Renders widget to the DOM immediately.

more details
more detailsWidget

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget

Selects the specified rows within the table.

more details
more detailsFeatureTable

Shows all the columns in the table.

more details
more detailsFeatureTable

Shows the specified column within the feature table.

more details
more detailsFeatureTable

Sorts the column.

more details
more detailsFeatureTable

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:
repeatable

The class names.

Returns:
TypeDescription
StringThe computed class name.
See also:
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:

The selection parameters to deselect within the feature table.

See also:
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:
TypeDescription
Booleantrue if a listener was notified
findColumn(fieldName)
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.

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:
TypeDescription
BooleanReturns 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.

on(type, listener){Object}inherited

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

Parameters:

A event type, or an array of event types, to listen for.

listener Function

The function to call when the event is fired.

Returns:
TypeDescription
ObjectReturns an event handler with a remove() method that can be called to stop listening for the event(s).
PropertyTypeDescription
removeFunctionWhen 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 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:
TypeDescription
ObjectThe 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.

selectRows(params)
Since: ArcGIS API for JavaScript 4.16

Selects the specified rows within the table.

Parameter:

The selection parameters to select within the feature table.

See also:
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
ValueDescription
ascSorts the column in ascending order.
descSorts the column in descending order.
Parameters:
path String

The specified field name to sort.

direction String

The direction to sort.

Possible Values:"asc"|"desc"

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.

menu items iconClass

optional

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

ButtonMenuItems array

open Boolean
optional

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

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.

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.

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.

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 toggleColums
optional

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

Event Overview

NameTypeSummaryClass
{added: Object[],removed: Object[],}

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

more details
more detailsFeatureTable

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", function(event){
  const addedRows = event.added; // An array of rows (features) added to the selection
  const removedRows = event.removed;  // An array of rows (features) removed from the selection
});

API Reference search results

NameTypeModule
Loading...