Skip to main content
Version: 2025.1

TreeTableViewTemplate

This page provides generated reference documentation for the TreeTableViewTemplate data model.

Displays one or multiple datasets as table, which can be grouped to a tree. Rows are datasets, columns are entity fields. You can select arbitrary entity fields in property "columns". Optionally, one or multiple fields can be specified as preselected grouping criteria (property "defaultGroupFields". The user can modify the grouping via the filter window.

Overview​

PropertySummary
autoNewRowDetermines if a new row should be added automatically, if the record state is NEW
children—
colspanThe colspan of the element.
columnsContains all defined columns for this component.
defaultGroupFieldsHas to contain a list of fields which are used for grouping the data. These grouping fields are set when the view is loaded and no fields have been set by the…
descriptionFieldEntity field, that holds the description text that is used if the table is transformed to a CardTable (e.g. on mobile devices)
devicesDetermines on wich devices the component should be available.
editRendererMappingMapping that specifies how an entity field should be rendered in edit mode. If no custom mapping is defined the default renderers are used.
enableDragAndDropDefines if drag and drop functionality within the TreeTable is enabled or not. If enabled it's possible for the user to drag rows onto new parent rows.
entityFieldThis property is mandatory. Its value must be set to 1. #ENTITY, when the ViewTemplate uses multiple EntityFields of the Entity belonging to the View…
entryActionA action that is executed on double click on an entry
expandRootItemsDefines if the items in the root level should be expanded initially.
favoriteActionGroup1First action group to place additional actions in
favoriteActionGroup2Second action group to place additional actions in
favoriteActionGroup3Third action group to place additional actions in
fixedFilterFieldsDefines the fields which shall be always shown on the filter. The will not be able to remove them entirely.
hideActionsDetermines if the action buttons are hidden or not
hideColumnSelectorIf true, the column selector of the table is hidden.
hideContentSearchDetermines, if the content search of the treetable is hidden or not.
hideHeaderDefines if the column headers of the grid shall be hidden.
iconFieldDetermines the field, that holds the icon 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…
initialVisibleColumnsDetermines, which columns the table should display initially. If none are set then all columns will be visible. Other configured columns from the…
isCreatableCreatable yes/no.
isDeletableDeletable yes/no.
isEditableEditable yes/no.
layoutMappingMaps a column to specific layout properties e.g. textAlignment
linkedColumnsDefines the columns which shall be displayed as a native link.
maxDBRowSets the maximum number of data rows to be gathered from the database
nodeExpandedFieldDefines the field which defines if the node shall be initially expanded or not.
parentFieldDefines the entityfield in which the ParentID is located.
rowspanThe rowspan of the element.
showChildrenCountDetermines, if the count of the underlying children is shown
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
titleTitle of the component
titleFieldEntity field, which holds the title that is used if the table is transformed to a CardTable (e.g. on mobile devices)
useBreadCrumbsDetermines if the current TREE_TABLE or TREE should use the bread-crumb variant for Tablet. It will always be used on Mobile and never on Desktop
viewRendererMappingMapping 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.

defaultGroupFields​

Type: String[]

Has to contain a list of fields which are used for grouping the data. These grouping fields are set when the view is loaded and no fields have been set by the user. If a default filter with grouping has been defined, they will overwrite the default grouping.

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.

enableDragAndDrop​

Type: Boolean
Default: false

Defines if drag and drop functionality within the TreeTable is enabled or not. If enabled it's possible for the user to drag rows onto new parent rows.

<!--EOF-->

This property is only used if parentField is set.

entityField​

Type: String

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 (default).
  2. 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

A action that is executed on double click on an entry

expandRootItems​

Type: Boolean
Default: false

Defines if the items in the root level should be expanded initially.

When enabling this property performance issues might arise when too many root nodes are automatically expanded.

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 the action buttons are hidden or not

hideColumnSelector​

Type: Boolean
Default: false

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

hideContentSearch​

Type: Boolean
Default: true

Determines, if the content search of the treetable is hidden or not.

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.

isCreatable​

Type: Boolean
Default: true

Creatable yes/no.

isDeletable​

Type: Boolean
Default: true

Deletable yes/no.

isEditable​

Type: Boolean
Default: true

Editable 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.

maxDBRow​

Type: Integer
Default: 400
Constraints: Minimum: Integer.MIN_VALUE, Maximum: Integer.MAX_VALUE

Sets the maximum number of data rows to be gathered from the database

nodeExpandedField​

Type: String

Defines the field which defines if the node shall be initially expanded or not.

When enabling this property then performance issues might arise when too many nodes are automatically expanded.

Only works for trees with a mapped parentField.

parentField​

Type: String

Defines the entityfield in which the ParentID is located.

This serves as the parent/child mapping for chart drilldown or mapping for the rows of a TreeTable.

rowspan​

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

The rowspan of the element.

showChildrenCount​

Type: Boolean
Default: true

Determines, if the count of the underlying children is shown

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)

useBreadCrumbs​

Type: Boolean
Default: false

Determines if the current TREE_TABLE or TREE should use the bread-crumb variant for Tablet. It will always be used on Mobile and never on Desktop

  • true - the bread-crumb variant will be used for Tablet and Mobile
  • false - the bread-crumb variant will only be used on Mobile
  • default: false

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.