Skip to main content

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​

PropertySummary
titleTitle of the component
devicesDetermines 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…
children—
favoriteActionGroup1First action group to place additional actions in
favoriteActionGroup2Second action group to place additional actions in
favoriteActionGroup3Third action group to place additional actions in
entryActionDetermines the action for an entry
entityFieldThis property is mandatory. Its value must be set to
columnsContains all defined columns for this component.
initialVisibleColumnsDetermines, which columns the table should display initially. If none are set then all columns will be visible. Other configured columns from the…
linkedColumnsDefines the columns which shall be displayed as a native link.
iconFieldDetermines the field, that holds the icon that is used if the table is transformed to a CardTable (e.g. on mobile devices)
titleFieldEntity field, which holds the title that is used if the table is transformed to a CardTable (e.g. on mobile devices)
informationFieldDefines the field which provides additional information. The placement of the information label varies between the ViewTemplates. The information label is only…
subtitleFieldEntity 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
descriptionFieldEntity field, that holds the description text that is used if the table is transformed to a CardTable (e.g. on mobile devices)
fixedFilterFieldsDefines the fields which shall be always shown on the filter. The will not be able to remove them entirely.
isCreatableCreatable yes/no.
isEditableEditable yes/no.
isDeletableDeletable yes/no.
isSaveableSaveable yes/no.
autoNewRowDetermines if a new row should be added automatically, if the record state is NEW
linkedFrameLinked frame that is executed on action.
maxDBRowSets the maximum number of data rows to be gathered from the database
hideActionsDetermines, if actions are shown or not
hideContentSearchIf true, the content search of the table is hidden.
inlineEditDetermines, if the user is able to edit data with the table itself
hideColumnSelectorIf true, the column selector of the table is hidden.
hideHeaderDefines if the column headers of the grid shall be hidden.
viewRendererMappingMapping that specifies how an entity field should be rendered in view mode. If no custom mapping is defined the default renderers are used.
editRendererMappingMapping that specifies how an entity field should be rendered in edit mode. If no custom mapping is defined the default renderers are used.
layoutMappingMaps a column to specific layout properties e.g. textAlignment
colspanThe colspan of the element.
rowspanThe rowspan of the element.

title​

Type: String
Constraints: Verification: TITLE_LENGTH

Title of the component

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.

children​

Type: Children

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

entryAction​

Type: String

Determines the action for an entry

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.

columns​

Type: Column

Contains all defined columns for this component.

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.

linkedColumns​

Type: String[]

Defines the columns which shall be displayed as a native link.

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)

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)

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.

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

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)

fixedFilterFields​

Type: String[]

Defines the fields which shall be always shown on the filter. The will not be able to remove them entirely.

isCreatable​

Type: Boolean
Default: true

Creatable yes/no.

isEditable​

Type: Boolean
Default: true

Editable yes/no.

isDeletable​

Type: Boolean
Default: true

Deletable yes/no.

isSaveable​

Type: Boolean

Saveable yes/no.

autoNewRow​

Type: Boolean

Determines if a new row should be added automatically, if the record state is NEW

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

hideActions​

Type: Boolean

Determines, if actions are shown or not

hideContentSearch​

Type: Boolean
Default: true

If true, the content search of the table is hidden.

inlineEdit​

Type: Boolean
Default: false

Determines, if the user is able to edit data with the table itself

hideColumnSelector​

Type: Boolean
Default: false

If true, the column selector of the table is hidden.

hideHeader​

Type: Boolean

Defines if the column headers of the grid shall be hidden.

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.

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.

layoutMapping​

Type: LayoutMappingDataModel

Maps a column to specific layout properties e.g. textAlignment

colspan​

Type: Integer
Default: 1
Constraints: Minimum: 0, Maximum: Integer.MAX_VALUE

The colspan of the element.

rowspan​

Type: Integer
Default: 1
Constraints: Minimum: 0, Maximum: Integer.MAX_VALUE

The rowspan of the element.