Class Data Table
This component is used to edit or view data stored in a class instance. |  |
A Class Data Table displayed in a Class Instance Dashboard allows the subset of class instances related by one or more Class Relations to be displayed. Create relations between instances through the Select Related Items dialogue described below. Remove a relation between instances by selecting the target instance and clicking delete button.
Custom Toolbar Elements
The following toolbar elements are unique to the Class Data Table component.
Create Relations
This toolbar element appears on Class Data Tables in Class Instance Dashboards when the underlying Class is configured to allow the creation of Many to Many relations and the property Enable Create Relations Button is set to True.
 | Create Relations | Opens a window which allows the creation of Many to Many relations. |
Public Variables (Properties)
[?]
The Class Data Table component has the following basic properties and property groups that are common to all components:
Name, Advanced Properties, Container Properties, Styles, Preloader, Events, Bindings, Kebab Menu.
Inherited Variables (Properties)
Class Data Table component is internally based on Data Table component, so it inherits its shared properties.
Class Instance List
This property defines parameters of a class instance list managed by this component.
Variable Name: | classInstanceListParameters |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
storageContext | String | Storage Context. Path to class instance storage context |
storageView | String | View. Default view of selected class instance. |
storageQuery | String | Custom Query. Custom query for source data preparation. |
storageTable | String | Table. Custom table format for selected class instance. |
storageFilter | Data Table | Filter. Defines filtering rules for selected class instance. This nested data table has several fields:
|
storageSorting | Data Table | Sorting. Defines sorting rules for selected class instance.This nested data table has two fields:
|
relationField | String | Relation. Defines the field selected for relation with other class instances. |
dropRelatedRecord | Boolean | Drop Related Record. Considered when the user attempts to delete a class instance from the Class Data Table.
|
Instance ID
By default, the component shows all class instances related to the class instance with instanceId specified by the dashboard URL parameter instanceId. However, this value can be overridden by setting a different instanceId in this property. When a valid instanceId is provided, the component will instead display all class instances related to the class instance with this instanceId.
Variable Name: | instanceId |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
instanceId | String | Instance ID. If this field is filled, its value takes priority over the value of the instanceId parameter in the dashboard URL. |
Enable Add Row
Determines whether the Add Row button is displayed, which allows users to add rows to the class via the component. Rows can be added even if the Read Only property is enabled.
Variable Name: | enableAddRow |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
enableAddRow | Boolean | Enable Add Row |
Enable Delete Row
Determines whether the Delete Row button is displayed, which allows users to remove selected rows from the class via the component. Rows can be deleted even if the Read Only property is enabled.
Variable Name: | enableDeleteRow |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
enableDeleteRow | Boolean | Enable Delete Row |
Enable Import
Determines whether the Import button is enabled, which allows the user to insert rows from a file into the class via the component. Imports can be performed even if the Read Only property is enabled.
Variable Name: | enableImport |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
enableImport | Boolean | Enable Import |
Enable Create Relations Button
Determines whether the Create Relations button is enabled, which when clicked opens a window allowing users to create Many to Many relations. The class instance being displayed must have at least one relation defined to another class instance in order for the button to appear on the component.
Variable Name: | enableCreateRelationsButton |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
enableCreateRelationsButton | Boolean | Enable Create Relations Button |
Public Events
[?]
Inherited Events
Class Data Table component is internally based on Data Table component, so it inherits its shared events.
Custom Events
The following custom events of Class Data Tables behave similarly to the analogously named Data Table events, with the addition that they return the instanceId field of the relevant database record.
Cell Updated
This event fires when the user updates the value of a specific cell in the class.
Event Name: | cellUpdated |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
recordIndex | Integer | Record Index. Index of the updated cell's record. |
instanceId | String | Instance ID. Primary key value of the row containing the updated cell. |
field | String | Field. Name of the updated cell's field. |
value | Data Table | Value. New value entered in the cell. |
Row Added
This event fires when the user adds a row to the class.
Event Name: | rowAdded |
Records: | 0 |
Record Format:
Field Name | Field Type | Field Description |
instanceId | Integer | Instance ID. Primary key value of the added row. |
Row Removed
This event fires when the user removes a row from the class.
Event Name: | rowRemoved |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
recordIndex | Integer | Record Index. Index of the removed row. |
instanceId | Integer | Instance ID. Primary key value of the removed row. |
Was this page helpful?