• Reference
  • Nodes
  • Components
  • Data Table

Data Table Component

Data tables are powerful ways to display tabular data, like what you find in a CSV or SQL database.

Override the data property with the row-formatted data source (an array of objects with consistent keys). Often, this data is the result of a function (e.g. {{pgQuery1.data}}).

Data tables come batteries-included with support for:

  • Column controls (renaming, formatting, filtering, sorting)
  • Infinite scroll and pagination
  • Row selection / auto-advance
  • Downloading the underlying data (coming soon)
  • Custom cells (coming soon)

All data tables are virtualized and therefore remain performant when scrolling through large numbers of rows.

Properties

Visible

PropisVisible
Typeboolean
Default{{true}}

Whether or not this node is visible.

Enabled

PropisEnabled
Typeboolean
Default{{true}}

Whether or not this node is enabled.

Tooltip

Proptooltip
Typestring
Defaultundefined

The tooltip text to display when hovered or focused over this node.

Top

Proptop
Typenumber
Default1

The position of the node from the top side of the grid (grid-row-start).

Left

Propleft
Typenumber
Default1

The position of the node from the left side of the grid (grid-column-start).

Width

Propwidth
Typestring
Default640px

The width of the node. When this node is in a grid layout, this should be done using unitless grid column units (specifying 4 will become grid-column-end: span 4). When this node is in a stack layout, the width must be specified using CSS units (e.g. 100px or 100%).

Min Width

PropminWidth
Typestring
Defaultnone

The minimum width of the node. When this node is in a grid layout, this property is ignored.

Max Width

PropmaxWidth
Typestring
Defaultnone

The maximum width of the node. When this node is in a grid layout, this property is ignored.

Height

Propheight
Typestring
Default480px

The height of the node. When this node is in a grid layout, this should be done using unitless grid row units (specifying 4 will become grid-row-end: span 4). When this node is in a stack layout, the height must be specified using CSS units (e.g. 100px or 100%).

Min Height

PropminHeight
Typestring
Defaultnone

The minimum height of the node. When this node is in a grid layout, this property is ignored.

Max Height

PropmaxHeight
Typestring
Defaultnone

The minimum height of the node. When this node is in a grid layout, this property is ignored.

Overflow

Propoverflow
TypeOverflow ('auto' | 'visible' | 'hidden' | 'scroll')
Defaultauto

The strategy used to handle overflow in the horizontal and vertical axes for content that is larger than its container.

Overflow X

PropoverflowX
TypeOverflow ('auto' | 'visible' | 'hidden' | 'scroll')
Defaultauto

The strategy used to handle overflow in the horizontal axis for content that is larger than its container.

Overflow Y

PropoverflowY
TypeOverflow ('auto' | 'visible' | 'hidden' | 'scroll')
Defaultauto

The strategy used to handle overflow in the vertical axis for content that is larger than its container.

Custom Styles

Propstyles
Typestring
Defaultelement.styles { }

Custom CSS styles to be applied to the node. Use element.styles to refer to the current node.

Object Fit

PropobjectFit
TypeObjectFit ('none' | 'contain' | 'cover' | 'fill' | 'scale-down')
Defaultcover

The strategy used to set how the content of a replaced element should be resized to fit its container.

Data Source

Propdata
Type(UnknownRecord | Array<UnknownRecord>)
Defaultundefined

The table data in row-wise format. An array of objects with consistent keys, this is often the result of a function (e.g. {{pgQuery1.data}}).

Auto Columns

PropautoColumns
Typeboolean
Default{{true}}

Auto generate columns when data changes

Columns

Propcolumns
Typearray
Default[]

The column configuration for the data table.

Column Configuration

Propcolumns[]
Typeobject

Options for each column

Column Header

Propcolumns[].header
Typestring

The text to show at the top of the column

Key

Propcolumns[].accessor
Typestring

The property in the data to read for this column

ID

Propcolumns[].id
Typestring

A unique ID for this column

Width

Propcolumns[].width
Typenumber

The desired width for the column

Min Width

Propcolumns[].minWidth
Typenumber

The minimum width in px

Render As

Propcolumns[].renderAs
TypeColumnRenderingMethod ('default' | 'date' | 'time' | 'datetime' | 'boolean' | 'json' | 'raw' | 'button')

The format for data in the column

Datetime format

Propcolumns[].dateTimeFormat
Typestring

A format string for datetimes in this column, (formatting reference)

Width Unit

Propcolumns[].widthUnit
Typestring

The unit of the width value

Min Width Unit

Propcolumns[].minWidthUnit
Typestring

The unit of the min-width value

Is Visible

Propcolumns[].isVisible
Typeboolean

Should the column be shown in the table

Allow Sort

Propcolumns[].allowSortBy
Typeboolean

Should the column be sortable

Button Text

Propcolumns[].buttonText
Typestring

The text to display on the button

On Click

Propcolumns[].onButtonClick
Type({ function: { ref: string } } | null)

What function will be called when the button is clicked

Flatten

Propflatten
Typeboolean
Default{{false}}

Whether or not to flatten the data source's keys. For example, if the data table receives a deeply nested row object like [{ "foo": { "bar": "baz", "qux": "quux" }], it will flatten these keys to two columns named foo.bar and foo.qux.

Selected Row

PropselectedRow
Typeunknown
Defaultundefined

The currently selected row of the data table. This property contains the row object itself, and so can be used to access keys on the underlying object.

Selected Row Index

PropselectedRowIndex
Typenumber

The currently selected row's index within the data table. This property will reflect the numeric index within the data source that is selected. 0-indexed — the first row is 0, second row is 1, etc.

Default First

PropautoselectFirstRow
Typeboolean
Default{{false}}

Whether or not to auto-select the first row of the data table upon initialization. Useful for auto-advancing through items in the data table, such as when building approval workflows.

Pagination

ProppaginationEnabled
Typeboolean
Default{{false}}

Exposes the pagination controls for the user to bind to function calls

Page Size

ProppageSize
Typenumber

Number of rows per page, used to set parameters on paginated query

Current Offset

ProppaginationOffset
Typenumber
Default0

Offset to begin data query from, used to set parameters on paginated query

Current Page

PropcurrentPage
Typenumber
Default1

Current page being displayed

Total Rows

ProptotalRowCount
Typenumber

Number of entries in the data set, used to set bounds on pagination

Event Handlers

On Wheel

HandlerdataTableNode.onWheel

Called when the user scrolls the node. Use this event to trigger downstream actions when this node is scrolled.

On Hover

HandlerdataTableNode.onHover

Called when the user hovers on the node. Use this event to trigger downstream actions when this node is hovered.

On Leave

HandlerdataTableNode.onLeave

Called when the user is not hovering over the node. Use this event to trigger downstream actions when this node is no longer hovered.

On Select Row

HandlerdataTableNode.onSelectRow

Called when the selected row changes. Use this event to trigger downstream changes

On Refresh

HandlerdataTableNode.onRefresh

Called when the refresh button is clicked. Use this event to trigger downstream changes

Last updated on November 7, 2022