TableViewTemplate
This page provides generated reference documentation for the TableViewTemplate data model.
Displays one or multiple datasets as table. Rows are datasets, columns are entity fields. You can select arbitrary entity fields in property "columns".
Overview
| Property | Summary |
|---|---|
| autoNewRow | Determines if a new row should be added automatically, if the record state is NEW |
| children | — |
| colspan | The colspan of the element. |
| columns | Contains all defined columns for this component. |
| descriptionField | Entity field, that holds the description text that is used if the table is transformed to a CardTable (e.g. on mobile devices) |
| devices | Determines on wich devices the component should be available. |
| editRendererMapping | Mapping that specifies how an entity field should be rendered in edit mode. If no custom mapping is defined the default renderers are used. |
| entityField | This property is mandatory. Its value must be set to 1. #ENTITY, when the ViewTemplate uses multiple EntityFields of the Entity belonging to the View… |
| entryAction | Determines the action for an entry |
| favoriteActionGroup1 | First action group to place additional actions in |
| favoriteActionGroup2 | Second action group to place additional actions in |
| favoriteActionGroup3 | Third action group to place additional actions in |
| fixedFilterFields | Defines the fields which shall be always shown on the filter. The will not be able to remove them entirely. |
| hideActions | Determines, if actions are shown or not |
| hideColumnSelector | If true, the column selector of the table is hidden. |
| hideContentSearch | If true, the content search of the table is hidden. |
| hideHeader | Defines if the column headers of the grid shall be hidden. |
| iconField | Determines the field, that holds the icon that is used if the table is transformed to a CardTable (e.g. on mobile devices) |
| informationField | Defines the field which provides additional information. The placement of the information label varies between the ViewTemplates. The information label is only… |
| initialVisibleColumns | Determines, which columns the table should display initially. If none are set then all columns will be visible. Other configured columns from the… |
| inlineEdit | Determines, if the user is able to edit data with the table itself |
| isCreatable | Creatable yes/no. |
| isDeletable | Deletable yes/no. |
| isEditable | Editable yes/no. |
| isSaveable | Saveable yes/no. |
| layoutMapping | Maps a column to specific layout properties e.g. textAlignment |
| linkedColumns | Defines the columns which shall be displayed as a native link. |
| linkedFrame | Linked frame that is executed on action. |
| maxDBRow | Sets the maximum number of data rows to be gathered from the database |
| rowspan | The rowspan of the element. |
| subtitleField | Entity field, that holds an additional title that is used if the table is transformed to a CardTable (e.g. on mobile devices). Shown below the title field |
| title | Title of the component |
| titleField | Entity field, which holds the title that is used if the table is transformed to a CardTable (e.g. on mobile devices) |
| viewRendererMapping | Mapping that specifies how an entity field should be rendered in view mode. If no custom mapping is defined the default renderers are used. |
autoNewRow
Type: Boolean
Determines if a new row should be added automatically, if the record state is NEW
children
Type: Children
colspan
Type: Integer
Default: 1
Constraints: Minimum: 0, Maximum: Integer.MAX_VALUE
The colspan of the element.
columns
Type: Column
Contains all defined columns for this component.
descriptionField
Type: String
Entity field, that holds the description text that is used if the table is transformed to a CardTable (e.g. on mobile devices)
devices
Type: EDeviceType[]
Determines on wich devices the component should be available.
The default value states that the component is available on all devices. If one or more devices are selected then the component is only available for those selected devices.
editRendererMapping
Type: RendererMappingDataModel
Mapping that specifies how an entity field should be rendered in edit mode. If no custom mapping is defined the default renderers are used.
entityField
Type: String
This property is mandatory. Its value must be set to
#ENTITY, when the ViewTemplate uses multiple EntityFields of the Entity belonging to the View (default).- a single EntityField, if the ViewTemplate uses only this one single EntityField (example: WebContentViewTemplate).
The second option will result in a performance optimization.
entryAction
Type: String
Determines the action for an entry
favoriteActionGroup1
Type: String
First action group to place additional actions in
favoriteActionGroup2
Type: String
Second action group to place additional actions in
favoriteActionGroup3
Type: String
Third action group to place additional actions in
fixedFilterFields
Type: String[]
Defines the fields which shall be always shown on the filter. The will not be able to remove them entirely.
hideActions
Type: Boolean
Determines, if actions are shown or not
hideColumnSelector
Type: Boolean
Default: false
If true, the column selector of the table is hidden.
hideContentSearch
Type: Boolean
Default: true
If true, the content search of the table is hidden.
hideHeader
Type: Boolean
Defines if the column headers of the grid shall be hidden.
iconField
Type: String
Determines the field, that holds the icon that is used if the table is transformed to a CardTable (e.g. on mobile devices)
informationField
Type: String
Defines the field which provides additional information. The placement of the information label varies between the ViewTemplates. The information label is only shown once per ViewTemplate.
initialVisibleColumns
Type: String[]
Determines, which columns the table should display initially. If none are set then all columns will be visible. Other configured columns from the "columns"-property will still be available for the user within the columnSelector component.
inlineEdit
Type: Boolean
Default: false
Determines, if the user is able to edit data with the table itself
isCreatable
Type: Boolean
Default: true
Creatable yes/no.
isDeletable
Type: Boolean
Default: true
Deletable yes/no.
isEditable
Type: Boolean
Default: true
Editable yes/no.
isSaveable
Type: Boolean
Saveable yes/no.
layoutMapping
Type: LayoutMappingDataModel
Maps a column to specific layout properties e.g. textAlignment
linkedColumns
Type: String[]
Defines the columns which shall be displayed as a native link.
linkedFrame
Type: String
Linked frame that is executed on action.
maxDBRow
Type: Integer
Constraints: Minimum: Integer.MIN_VALUE, Maximum: Integer.MAX_VALUE
Sets the maximum number of data rows to be gathered from the database
rowspan
Type: Integer
Default: 1
Constraints: Minimum: 0, Maximum: Integer.MAX_VALUE
The rowspan of the element.
subtitleField
Type: String
Entity field, that holds an additional title that is used if the table is transformed to a CardTable (e.g. on mobile devices). Shown below the title field
title
Type: String
Constraints: Verification: TITLE_LENGTH
Title of the component
titleField
Type: String
Entity field, which holds the title that is used if the table is transformed to a CardTable (e.g. on mobile devices)
viewRendererMapping
Type: RendererMappingDataModel
Mapping that specifies how an entity field should be rendered in view mode. If no custom mapping is defined the default renderers are used.