Skip to main content

Table Grid

The Table Grid control is a type of Display control that obtains data from a Sheet, connector, or other data source and displays it in a table format. The table can be sorted, filtered, paginated, and downloaded, and includes features like row selection and insertion, server-side pagination, and custom columns.

table Grid
Table Grid

Binding Data Options

Table Grid control accepts array of objects to display data. There are different ways in which you can bind data to the Table Grid control.

Static Data Option

To display static options in the Table Grid control, you can use the Bind Data option.

The Bind Data option must be specified as an array of objects. For example:

  [
{
"id": 1,
"name": "Carlyn Bartle",
"email": "Carlyn.Bartle@example.com"
},
{
"id": 2,
"name": "Murry Rowsel",
"email": "Murry.Rowsel@example.com"
}
]

Dynamic Data Option

You can dynamically Bind options by fetching data from Data queries, Sheets or Custom functions by binding the response to the Data Bind option. For example:

Let's fetch data from a configured SQL connector."We have a predefined query, getDetails, that fetches data from the SQL database using the connector." The SQL syntax for this query:

  SELECT * FROM orderdetails

In the Table Grid control, Bind Data Options, select the Quick Select -> Connector Library -> SQL_Connector -> getDetails

Date Range Picker
Binding Dynamic data from connector to Table Grid control.

Real-time visualization of table grid control changes in the builder view, with updated data fetched from an SQL database.

Server-Side Pagination

Server-side pagination is a technique for displaying large data sets in a web application by dividing the data into pages and only sending the current page to the browser. This can improve performance and make the data easier to manage.

Pagination is enabled in the table grid control by toggling on the Allow Pagination option. When pagination is enabled, you can set three properties for the table grid control: LIMIT, OFFSET, and ROWS PER PAGE.

LIMIT defines the number of records fetched for a single page. ROWS PER PAGE sets the number of rows visible per page. OFFSET is used to skip the first n rows.

For connectors that support cursor-based pagination, such as Airtable, you must select Cursor Based Pagination as the type and use the OFFSET key from the respective connector.

PropertyDescription
Rows per pageThis allows you to set the index value of the default selected row.
Default offsetThis allows you to set the default Offset to start pagination from.
Default selected rowIs the row selected by default on loading of the data.
HeightThis allows you to set the height for the table grid control.
VisibleBy default you can set the visible rows and columns to specify the height of the control.
info

When the pagination is enabled your Filter and the Search features do not work on the columns. However, if you disable pagination you would note that the search provides you with the rows matching the search text. The Filter feature would also allow you specify the filter conditions

Properties

PropertyDescription
Table HeaderSpecifies the font size and font weight for the table header.
Table DataSpecifies the font size and font weight for the table data.
ThemeAllows you to specify the theme for the table grid.
Row Background ColorsSet the background color for odd and even rows distinctively
Column WidthAllows you to specify the maximum and minimum width of the columns in the table.

Top Bar

PropertyDescription
SearchbarToggle ON or OFF to Show the Searchbar.
Column reorder and visibilityToggle button on ON/OFF enables you to reorder the columns and toggle the visibility of columns on the client-side of the app.
AddButton to specify the buttons to be displayed. You can add the button for Add, update, delete, download, refresh, filters, quick filter, and row size.
UpdateSelect row/s and click Update to modify the record.
DeleteSelect row/s and click Delete to delete the selected record.
Download File NameAllows you to specify the default file name for the CSV file downloaded from the table grid.
RefreshThis will refresh the data in the Table grid depending upon the actions performed.
FiltersAllows you to apply Filter to the data. You can choose the filter and click Apply. The data would be displayed according to your selection.
Quick FilterAllows you to add a quick filter for the selected column. Quick filter would be applied on columns that are of type Single Tag or Multi-Tag.
Row SizeThis adds the option to change the row size as small, medium, or large.
Choose columns that will be editableThis property helps you to choose one or more than one column from the table grid and make it editable.

Display

PropertyDescription
MapToggle on or off the Map view to display data like the co-ordinates on a Map.
Default viewThis allows you to select the default view as Map or List.
Show ThumbnailsEnable Show Thumbnails when you want your Images to be displayed as thumbnails. The column would be of type File. If it contains PDFs the PDF file icon would be shown.
Detailed viewThis allows you to switch ON or OFF to show data in the Detailed view of your sheet data. Whenever you click any of the records it would display the row data as a detailed view.
Show Key Value MapThis would display the selected row as a key-value map instead of the default grid (as seen in above screenshot).
CustomizeBy switching on Customize, you can customize the columns shown in the detailed view. By default all columns are shown, however, you can select a limited number as well if you want to give a quick look at the data.
Select columnWhen you enable Customize property above, you can then select the columns to be displayed in the Detailed view.
Group dataEnable to Group your Data and select the column to Group By. The rows would appear in the Accordion Style selected.
Group byAllows you to select the column to group by.
Show Aggregation FooterThis checkbox allows you to generate an aggregate value of different distinct information such as unique values, the number of values, the sum of values, empty values, checked values, and more, then displays the result at the bottom of its respective columns.
Freeze ColumnsThis property enables you to select the number of columns from the table grid control which you want to appear as frozen in tablegrid control while doing horizontal scrolling on it.
Fit height to screenEnable to set the Height of the Table grid to fit the screen. During pagination, the table fits the screen and you can scroll within the table within the area.
CheckboxThis allows you to add a single select or multi-select check box in your table grid data. It has options as Yes (with single select), Yes (with multi-select), and No.
PaginationThis allows you to enable pagination for your data. When you allow pagination some more properties would be added to your list of properties. You can have Limit Offset based pagination or Cursor Based Pagination.

Actions

PropertyDescription
On Row clickThis is the default action on click of the Table grid row. You can Navigate to another page, Select a Row, or Show details.
Navigate with SelectionIf you select the Navigate with Selection action you would be able to further define the navigation.
TypeSpecify the type of navigation as Navigate (With validation) or Navigate (Without validation).
ToSpecify the page/ screen to navigate to.
TransitionYou can specify the transition style for your page when navigating.
ActionsThe remaining Actions (Action 1, Action 2…) allow you to set the actions that would be performed when the row/s are selected.
Action TextAdd a Action Text and select a color for the Action Text.
IconAllows you to select the Icon for the action.
ColorAllows you to add the color of the icon.
Show onAllows you to set when the action should be shown. It can be Single-select, Multiselect, or Both.
Show on hoverAllows you to set whether the action or action icon would be shown when you hover over the selected row.
Bind to ColumnNow you can bind the hover functionality of the action or action icon to a specific column instead of the end of the table.
Add as columnThis adds the action as a column which can then be selected by you to trigger further action. It will appear as the action text in the last column by default but you can set the position for the column to display in your table grid control using Column Index of Action by specifying the position for the column to be added in numeric value.

Control Outputs

These outputs can be referenced in other controls, data queries, or JS functions using the control's unique name.

PropertyDescription
{{tablegrid.PROPERTIES.SEARCHTEXT}}The search text that is currently being used to filter the data in the table grid.
{{tablegrid.PROPERTIES.OFFSET}}The offset of the first row that is currently being displayed in the table grid.
{{tablegrid.PROPERTIES.LIMIT}}The number of rows that are currently being displayed in the table grid.
{{tablegrid.PROPERTIES.STARTROW}}The index of the first row that is currently being displayed in the table grid.
{{tablegrid.PROPERTIES.ENDROW}}The index of the last row that is currently being displayed in the table grid.
{{tablegrid.PROPERTIES.EDITEDROWS}}The number of rows that have been edited in the table grid. This keyword sends the whole array of the row data whose columns have been edited.
{{tablegrid.PROPERTIES.NEWROWS}}The number of rows that have been newly created in the table grid.
{{tablegrid.PROPERTIES.SELECTEDROWS}}The number of rows that are currently selected in the table grid.
{{tablegrid.PROPERTIES.EDITEDTABLE}}This property allows users to edit data in a table grid without making any changes to the underlying data source. The altered data can be used by the table grid itself or exported to another data source.

Events

TriggerDescription
row_selectOccurs when a row in the table or a list is selected.
add_clickOccurs when the add button for adding new items is clicked.
update_clickOccurs when the update button for updating existing items is clicked.
delete_clickOccurs when the delete button for deleting items is clicked.
save_changesOccurs when the save button for saving changes is clicked, typically after editing or updating.
refresh_clickOccurs when you click the refresh button of the table grid control