For the managed package runtime, datatable element properties are configurable in the Property Panel when you select a Datatable element in the Flexcard Designer. With the Datatable element, display a tabular structure of the data fetched from a data source.
This information is for Omnistudio for Managed Packages. For Omnistudio on standard
runtime, see Omnistudio Help.
| Property | Description | Reference |
|---|---|---|
| Column | Update the data fields to populate the table and set options for columns, such as Type and Selectability. | n/a |
| Conditions | Add a condition that must be met for the element to display. | Add Conditions to a Flexcard Element (Managed Package) |
| Element Name | The name of the element as seen on the canvas. Used to distinguish one element from another as you build your Flexcard in the designer. Is used only within the designer. | Flexcard Naming Conventions (Managed Package) |
| Records | Specify the record data that populates the table. Defaults to {records}. | n/a |
Attributes
Note The Accessibility Support property is supported in Winter '22
to display the Datatable Name property. Beginning Spring '22,
Datatable Name property is visible in the Properties panel by
default.
| Property | Description |
|---|---|
| Accessibility Support | Displays the Datatable Name property where you can add an aria-label for accessibility users. |
| Cell Level Edit | Enable support for cell-level inline-editing. Select which columns are editable from the Column property. |
| Datatable Name | Adds an aria-label for accessibility users. The text isn’t visible on screen and only visible to assistive technologies. |
| Draggable | Enable the ability to rearrange rows by dragging them up or down. |
| Extra Class | Enter a class appended to the container of the element. Select from a class defined in the Add Custom CSS feature of the Flexcard Designer or any style sheet available to the Flexcard. |
| Fire Event On Delete Confirm | Enable to fire a delete custom event when a row is deleted. |
| Hide Table Header | Enable to hide the table header. |
| Is Searchable | Enable the ability to search all column values. Limit which columns are searchable from the Column Property. |
| Is Sortable | Enable support for sorting all columns. Limit which columns are sortable from the Column Property. |
| Page Limit | Specify the number of page navigation links to add to pagination. The Page Size property must be enabled. |
| Page Size | Enable pagination by specifying how many records to display on each page. If using Group By, the Page Size is determined by the number of groups instead of the number of rows. |
| Row Delete Dependent Column | Enable the ability to delete a row based on a data field value returning as false. The field must have a boolean (true or false) value and Row Delete must be enabled. |
| Row Delete | Enable the ability to delete a row from the Flexcard. The record isn’t
deleted in the database. Triggers the delete event. |
| Row Level Edit | Enable support for row-level inline-editing. |
| Show Confirm Modal Before Row Delete | Enable to display a confirmation window before a row gets deleted. |
| User Selectable Column | Allow users to select which columns are visible. Select specific columns from the Column property. |
| User Selectable Row | Make row selectable by adding a checkbox at the beginning of each row.
Triggers the selectrow event. |
Group Attributes
| Property | Description |
|---|---|
| Active Groups | Enable to expand all groups. |
| Group By | Group table rows by a data field. |
| Group Order | Sort groups in ascending or descending order. |
| Group Wrapper Class | Add a class to the wrapper surrounding each group name. |
| Hide Extra Column | Enable to remove the space below and above the group name. |
| Sort Across Groups | Sorts both the groups and the rows within each group when a column head is clicked. By default, sorting happens within each group when a column head is clicked. View functionality in Preview. |
Column Properties
These properties are visible in the Add DataTable Columns window when you click the Column property.
| Property | Description |
|---|---|
| Field Label | Update the name of the field column. By default, the field label is the Field Name. |
| Field Name | Select the field column to display. |
| Is Sortable | Select which fields are sortable. Enable Is Sortable under Attributes in the Properties panel. |
| Is Searchable | Select which fields are searchable from the search form. Enable Is Searchable under Attributes in the Properties panel. |
| Type | Select the type of data the field column displays. For example, if an Account field name is AnnualRevenue, select Currency. |
| Is Editable | Select which field column a user can edit. Enable Cell Level Edit under Attributes in the Properties panel. |
| Is User Selectable | Select which field columns a user can hide or show. Enable User Selectable Column under Attributes in the Properties panel. |
| Is Visible | Select which field columns are hidden or visible by default. Use with Is User Selectable to enable users to display hidden field columns. |
Datatable Events
| Event Name | Event Description |
|---|---|
| update | Fires when table data changes. |
| selectrow |
Fires when a row is updated. Enable User Selectable Row. The selectrow event contains data for the current row only, not all previously selected rows. To collect data for all selectrow events requires event handling. |
| rowclick |
Fires when a row is clicked. The rowclick event contains the record of the row on which the user clicks. |
| delete | Fires when a row is deleted. Enable Row Delete. |