Blocks Deprecated
Deprecated: use the web blocks for new pages This block belongs to state pages and UI components. Existing pages keep running, but new pages should use the web blocks. See Web Pages and the migration guide.

advanced datatable

This block is part of the state ui group and was last modified in core v13.0.6.

Storage Selection Required

This block relies on a storage to perform its storage releated actions. You must manually select the storage you want to use in your flow using the storage selector modal. To access the modal, click the white button on the block.

advanced datatable v13.0.1 Updated v13.0.6

A pre-styled advanced table showing data using advanced tooling

In pins 19
  • state key value

    The state to bind the datatable to. If it is updated, the component will re-render

  • columns fielddefinitions required

    Choose the columns you want to show

  • overwrite column titles array v13.0.8

    Overwrite the title of a specific column.

  • columns width array

    Choose the widths of the columns in percentage, expects array of numbers. e.g. 5 for 5% in width.

    Default 100%

  • columns sortable fielddefinitions

    Choose which columns can be sorted, by default we will not do any sortable fields

  • overwrite column sort field array v13.0.8

    Overwrite which field will be sorted on column sort. With this function it is possible to sort on non existing columns / fields that are made up by combining multiple different values or are returned by the row render.

  • columns filterable fielddefinitions v13.0.7

    Choose which columns can be filtered, by default we will not do any filterable fields

  • search fields fielddefinitions

    Fields that will be searched on in addition to the column fields

  • return fields fielddefinitions v13.0.8

    Fields that will be returned during the search. Should be set if the data sent to the frontend should be limited due to confidential fields.

    Default *

  • row actions statedatatableconnection

    Actions that are specific to the row like edit, detail, json, revision or inline edit

  • query query

    Query used as a base for the datatable

  • show top pagination condition v14.0.1

    Adds a pagination to the top of the table

    Default false

  • rows per page number

    Number of results per page in the table

    Default 30

  • rows per page options array v13.0.8

    Options to show in the dropdown at the bottom right

    Default 10, 30, 50, 100

  • filters statedatatablefilter

    Adds filtering to the datatable

  • Storage storage
  • class uiclass

    Assigns a CSS class to the element. • Hidden when unused

  • style uistyle

    Applies inline CSS style to the element • Hidden when unused

  • attributes uiattributes

    Adds custom attributes to the element. • Hidden when unused

Out pins 4
  • state state

    Returns the element to the frontend state.

  • Map Row execute_function

    The function will be executed for each row and state pins can be returned to overwrite whats visible.

  • Row Component iteratestate

    The component will be executed for every row and replace the default values and columns. A tr should be returned. The available parameters are columns, row and index.

  • On change execute_function v14.0.3

    The function will be executed every time any of the search parameters changes.

A typical wiring for advanced datatable: combine feeds the columns pin; the function out pin wires to an execute block.

Studio canvas example for the advanced datatable block: typical wiring for advanced datatable.

Used in these guides

These documentation pages use or explain this block:

Version history

Introduced in v13.0.1.

Last modified in v13.0.6.

v14.0.3 This block or one of its pins was updated in v14.0.3, click here to see the release notes. v14.0.1 This block or one of its pins was updated in v14.0.1, click here to see the release notes. v13.0.8 This block or one of its pins was updated in v13.0.8, click here to see the release notes. v13.0.7 This block or one of its pins was updated in v13.0.7, click here to see the release notes.
Back to state ui Return to the main group to view all sub-groups Back to state elements Return to the group to view all blocks within this group