FeatureTableViewModel

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

Provides the logic for the FeatureTable widget, which allows users to view content from feature attributes in a tabular format.

See also:

Constructors

new FeatureTableViewModel(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
Booleanmore details

Indicates whether to display the Attachments field in the table.

more detailsFeatureTableViewModel
Stringmore details

The name of the class.

more detailsAccessor
Booleanmore details

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

more detailsFeatureTableViewModel
FieldColumnConfig[]more details

An array of individual configuration objects.

more detailsFeatureTableViewModel
Geometrymore details

Set this property to filter the features displayed in the table.

more detailsFeatureTableViewModel
Collection<string>more details

A collection of fields to remain hidden within the table.

more detailsFeatureTableViewModel
Booleanmore details

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

more detailsFeatureTableViewModel
FeatureLayer|SceneLayer|GeoJSONLayer|CSVLayer|WFSLayer|ImageryLayermore details

The associated FeatureLayer, SceneLayer, GeoJSONLayer, CSVLayer, ImageryLayer, or WFSLayer containing the fields and attributes to display within the widget.

more detailsFeatureTableViewModel
Stringmore details

The view model's state.

more detailsFeatureTableViewModel
MapViewmore details

A reference to the MapView.

more detailsFeatureTableViewModel

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 attachments enabled

Default Value:false
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 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.
  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]

An array of individual 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.

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:
Example:
// Filter the table to only display the associated feature(s) that fall within the filterGeometry's geometry, (e.g. Extent)
featureLayer.viewModel.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.viewModel.filterGeometry = view.extent;
    }
  });
});
hiddenFields Collection<string>
Since: ArcGIS API for JavaScript 4.16

A collection of fields to remain hidden within the table.

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 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. It is possible to set the default pagination using the FeatureTable's pageSize property.

See also:
state Stringreadonly

The view model's state.

Possible Values:"disabled"|"loading"|"ready"

Default Value:disabled
view MapView

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

Method Overview

Name Return Type Summary Class
more details

This clears any highlighted features.

more detailsFeatureTableViewModel
more details

Clears the current selection within the table.

more detailsFeatureTableViewModel
more details

Unselects the specified rows within the table.

more detailsFeatureTableViewModel
Numbermore details

Returns current row index for the associated feature.

more detailsFeatureTableViewModel
String|Number|nullmore details

Returns a field value given the specified feature ObjectId and an associated fieldName.

more detailsFeatureTableViewModel
more details

Refreshes the table contents.

more detailsFeatureTableViewModel
more details

Scrolls the table to a row based on specified index.

more detailsFeatureTableViewModel
more details

Selects the specified rows within the table.

more detailsFeatureTableViewModel

Method Details

clearHighlights()
Since: ArcGIS API for JavaScript 4.16

This clears any highlighted features.

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. Takes either individual or multiple ObjectId(s) or Graphic(s).

See also:
getObjectIdIndex(objectId){Number}

Returns current row index for the associated feature.

Parameter:
objectId Number

The ObjectId field of the specified feature.

Returns:
Type Description
Number
getValue(objectId, fieldName){String|Number|null}

Returns a field value given the specified feature ObjectId and an associated fieldName.

Parameters:
objectId Number

The ObjectId field of the specified feature.

fieldName String

The name of the field in which to get the associated ObjectId's feature value.

Returns:
Type Description
String | Number | null
  • Associated value for the specified feature, as provided using its ObjectId, under the given field value.
Example:
// Gets the field value for the specified field name, "OPENSTATUS" with the given feature ObjectId
const featureValue = featureTable.viewModel.getValue(feature.attributes.ObjectId, "OPENSTATUS");
console.log(featureValue);
refresh()
Since: ArcGIS API for JavaScript 4.16

Refreshes the table contents.

scrollToIndex(index)
Since: ArcGIS API for JavaScript 4.19

Scrolls the table to a row based on specified index.

Parameter:
index Number

Index of the row to scroll to.

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.Takes either individual or multiple ObjectId(s) or Graphic(s).

See also:

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