TableList

The TableList widget provides a way to display a list of tables associated with a Map. It is meant to be used with feature layer tables.

If a map contains feature layer tables, they will display within the widget. Tables can also be added to the map's tables collection. Any tables referenced in the map property will display in the widget. If unsure of whether the layer is a table, check the feature layer's isTable property.

The ListItem API provides access to each table, allows the developer to configure actions related to the table, and allows the developer to add content to the item related to the table.

Known Limitations The TableList widget is not supported with web scenes.

See also:

Example:

const tableList = new TableList({
  map: map, // takes any tables associated with the map and displays in widget
  selectionEnabled: true,
  listItemCreatedFunction: function(event) {
    let item = event.item;
    item.actionsSections = [
      {
        title: "Show table",
        className: "esri-icon-table",
        id: "table",
        type: "toggle"
      },
      {
       title: "Layer information",
       className: "esri-icon-description",
       id: "information"
      }
    ]
});

Constructors

new TableList(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
const tableList = new TableList({
  map: map
});

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\|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
String	more details The widget's default CSS icon class.	more details	iconClass
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	TableList
ListItemCreatedHandler	more details Specifies a function that accesses each ListItem.	more details	TableList
Map\|WebMap	more details A reference to a map containing the tables.	more details	TableList
Boolean	more details Indicates whether more than one list item can be selected by a user at a single time.	more details	TableList
Collection<ListItem>	more details A collection of selected ListItems representing table list items selected by the user.	more details	TableList
Boolean	more details Indicates whether list items may be selected by the user.	more details	TableList
Collection<ListItem>	more details The collection of table ListItems displayed within the widget.	more details	TableList
TableListViewModel	more details The view model for this widget.	more details	TableList
Boolean	more details Indicates whether the widget is visible.	more details	Widget

Property Details

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.

iconClass Stringinner

The widget's default CSS icon class.

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.

listItemCreatedFunction ListItemCreatedHandler

Specifies a function that accesses each ListItem. Each list item can be modified according to its modifiable properties. Actions can be added to list items using the actionsSections property of the ListItem.

Example:

const tableList = new TableList({
  map: map,
  selectionEnabled: true,
  listItemCreatedFunction: function(event) {
    let item = event.item;
    item.actionsSections = [
      [
        {
          title: "Go to full extent",
          className: "esri-icon-zoom-out-fixed",
          id: "full-extent"
        }
      ]
    ];
   }
});

map Map|WebMap

A reference to a map containing the tables. Set this property to access the underlying tables within the map.

See also:

Example:

Layer.fromPortalItem({
  // Loads a layer (table) from a portal item
  portalItem: { // autocasts new PortalItem()
    id: "add portal item id"
  }
}).then(function(layer) {
  // Load the layer
  layer.load().then(function() {
    // Check if the layer is a table
    if (layer.isTable) {
      map.tables.add(layer);
      console.log(map.tables);
    }
  });
});

const tableList = new TableList({
  map: map //  map contains tables collection
});

multipleSelectionEnabled Boolean

Indicates whether more than one list item can be selected by a user at a single time. SelectionEnabled must be set to true for this property to have an effect on the widget.

Selected items are available in the selectedItems property.

Default Value:false

See also:

selectionEnabled
selectedItems

Example:

tableList.selectionEnabled = true;
tableList.multipleSelectionEnabled = true;

selectedItems Collection<ListItem>

A collection of selected ListItems representing table list items selected by the user.

See also:

selectionEnabled

selectionEnabled Boolean

Indicates whether list items may be selected by the user. Selected items can by reordered in the list by drag and drop using the mouse or touch screen as well as with arrows on the keyboard.

Selected items are available in the selectedItems property.

Default Value:false

See also:

selectedItems

Example:

tableList.selectionEnabled = true;

tableItems Collection<ListItem>readonly

The collection of table ListItems displayed within the widget.

viewModel TableListViewModelautocast

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 TableListViewModel 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;

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 Destroys the widget instance.	more details	Widget
Boolean	more details Emits an event on the instance.	more details	Widget
Boolean	more details Indicates whether there is an event listener on the instance that matches the provided event name.	more details	Widget
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
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 Triggers the trigger-action event and executes the given action or action toggle.	more details	TableList
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)} />
  );
}

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

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.

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.

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.

triggerAction(action, item)

Triggers the trigger-action event and executes the given action or action toggle.

Parameters:

action ActionButton|ActionToggle

The action to execute.

item ListItem

An item associated with the action.

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

ListItemCreatedHandler(event)

Function definition for the listItemCreatedFunction property.

Parameters:

event Object

An object containing a list item created by the TableList.

Specification:

item ListItem

A list item created by the TableList. You can modify the properties of this item to customize the text, actions, and visibility of the list item. See the documentation for the listItemCreatedFunction for more details.

Event Overview

Name	Type	Summary	Class
	{action: ActionButton,ActionToggle,item: ListItem}	more details Fires after the user clicks on an action or action toggle inside the TableList widget.	more details	TableList

Event Details

trigger-action

Fires after the user clicks on an action or action toggle inside the TableList widget. This event may be used to define a custom function to execute when particular actions are clicked.

Properties:

action ActionButton|ActionToggle

The action clicked by the user.

item ListItem

An item associated with the action.

Example:

tableList.on("trigger-action", function (event) {
  let item = event.item;
  // Capture the action id.
  let id = event.action.id;

  if (id === "information") {
    window.open(item.layer.url);
  }
});

ArcGIS API for JavaScriptAPI Reference

Was this page helpful?

Was this page helpful?