Table
API
The Table
exposes the following API in the JavaScript runtime environment.
Property / Function | Type | Behavior |
---|---|---|
|
| 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". |
|
| Current boolean value of the "Show data type icons" property. |
|
| Removes row(s) with the provided primary key(s). Note: It does not automatically trigger the action linked to "On row add". |
|
| Current boolean value of the "Filtering" property. |
|
| Current boolean value of the "Show horizontal dividers" property. |
|
| Returns the row that was last clicked on as an object with the columns as keys. |
|
| Current boolean value of the "Multi-row selection" property. |
|
| Returns all rows that have been added to the table component before they have been saved (i.e. staged changes). |
|
| 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. |
|
| Returns how many records are in the table. It excludes all changes that have not been saved yet. |
|
| Executes the action that is specified in the event handler "On refresh click" |
|
| Returns a list of the primary keys present in table data. |
|
| Returns an object of objects containing all records in the table. The records are indexed by their primary key. |
|
| Returns all rows that are currently selected. |
|
| Sets the "Show data type icons" property to the provided value. |
|
| It sets the data that is displayed in the table component and takes an array of objects with the column headers as keys. |
|
| Sets the "Filtering" property to the provided value. |
|
| Sets the "Show horizontal dividers" property to the provided value. |
|
| Sets the "Multi-row selection" property to the provided value. |
|
| Selects all the rows for which the provided function evaluates to |
|
| Sets the "Show refresh button" property to the provided value. |
|
| Sets the "Show number of results" property to the provided value. |
|
| Sets the "Sorting" property to the provided value. |
|
| Sets the "Text search enables" property to the provided value. |
|
| Sets the "Show vertical dividers" property to the provided value. |
|
| Sets the "Visible" property to the provided value. |
|
| Current boolean value of the "Show refresh button" property. |
|
| Current boolean value of the "Show number of results" property. |
|
| Current boolean value of the "Sorting" property. |
|
| Returns the unsaved changes to the data in the table. |
|
| Current boolean value of the "Text search enabled" property. |
|
| 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". |
|
| 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". |
|
| Current boolean value of the "Show vertical dividers" property. |
|
| Current boolean value of the "Visible" property. |
Last updated