Table

API

The Table exposes the following API in the JavaScript runtime environment.

Property / Function	Type	Behavior
addRows(value)	(value: Object | Object[]) => {addedRowIds: number[]}	Appends a new row or a list of new rows to the data set. It takes an object that describes the row content containing all column fields or an array of those. Note: It does not automatically trigger the action linked to "On row add".
columnTypeIcons	boolean	Current boolean value of the "Show data type icons" property.
deleteRows(value)	(value: (string | number) | (string | number)[]) => {deletedRowIds: number[]}	Removes row(s) with the provided primary key(s). Note: It does not automatically trigger the action linked to "On row add".
filteringEnabled	boolean	Current boolean value of the "Filtering" property.
horizontalDividers	boolean	Current boolean value of the "Show horizontal dividers" property.
lastClickedRow	Object	Returns the row that was last clicked on as an object with the columns as keys.
multiRowSelection	boolean	Current boolean value of the "Multi-row selection" property.
newRecords	Object[]	Returns all rows that have been added to the table component before they have been saved (i.e. staged changes).
primaryKey	any	Returns the primary key that is in use in the table. The primary is either inferred from the underlying data source or explicitly set in the table.
recordCount	number	Returns how many records are in the table. It excludes all changes that have not been saved yet.
refresh()	() => void	Executes the action that is specified in the event handler "On refresh click"
rowIds	any[]	Returns a list of the primary keys present in table data.
rowsById	Object	Returns an object of objects containing all records in the table. The records are indexed by their primary key.
selectedRows	Object[]	Returns all rows that are currently selected.
setColumnTypeIcons(value)	(value: boolean) => void	Sets the "Show data type icons" property to the provided value.
setData(value)	(value: Object[]) => void	It sets the data that is displayed in the table component and takes an array of objects with the column headers as keys.
setFilteringEnabled(value)	(value: boolean) => void	Sets the "Filtering" property to the provided value.
setHorizontalDividers(value)	(value: boolean) => void	Sets the "Show horizontal dividers" property to the provided value.
setMultiRowSelection(value)	(value: boolean) => void	Sets the "Multi-row selection" property to the provided value.
setSelectedRows(value)	(value: Function) => boolean	Selects all the rows for which the provided function evaluates to true. The function must be of the following type: (row: Object, rowIndex: number) => boolean
setShowRefreshButton(value)	(value: boolean) => row	Sets the "Show refresh button" property to the provided value.
setShowResultNumber(value)	(value: boolean) => row	Sets the "Show number of results" property to the provided value.
setSortingEnabled(value)	(value: boolean) => row	Sets the "Sorting" property to the provided value.
setTextSearchEnabled(value)	(value: boolean) => row	Sets the "Text search enables" property to the provided value.
setVerticalDividers(value)	(value: boolean) => row	Sets the "Show vertical dividers" property to the provided value.
setVisible	(value: boolean) => row	Sets the "Visible" property to the provided value.
showRefreshButton	boolean	Current boolean value of the "Show refresh button" property.
showResultNumber	boolean	Current boolean value of the "Show number of results" property.
sortingEnabled	boolean	Current boolean value of the "Sorting" property.
stagedChanges	{ rowId: number, rowIndex: number, oldRowData: Object, newRowData: Object, row: Object, changes: Object }	Returns the unsaved changes to the data in the table.
textSearchEnabled	boolean	Current boolean value of the "Text search enabled" property.
updateOrAddRows(value)	(value: Object | Object[]) => {addedRowIds: number[], updatedRowIds: number[]}	Takes an record or an array of records that should be added or updated and modifies the table data. For updates it expects an object containing the primary and all columns that should be updated while it expects an object with all columns for rows that should be added. Note: It does not automatically trigger the actions linked to "On row add" and "On row update".
updateRows(value)	(value: Object | Object[]) => {updatedRowIds: number[]}	Updates a record or a list of records in the data set. It takes an object that describes the row content containing the primary key and all columns that should be updated. Note: It does not automatically trigger the actions linked to "On row add" and "On row update".
verticalDividers	boolean	Current boolean value of the "Show vertical dividers" property.
visible	boolean	Current boolean value of the "Visible" property.