TreeViewTemplate
This page provides generated reference documentation for the TreeViewTemplate data model.
Displays, at fixed positions, certain fields (title, icon, etc.) of multiple data sets in a vertical list, which can be grouped to a tree.
Overview
| Property | Summary |
|---|---|
| children | List of children in this container |
| colspan | The colspan of the element. |
| defaultGroupFields | 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… |
| descriptionField | Defines the field which provides the description for the current node. |
| 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 |
| expandRootItems | Defines if the items in the root level should be expanded initially. |
| 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 | Defines if the actions shall be hidden. |
| hideContentSearch | If true, the content search of the table is hidden. |
| iconField | Defines the field which provides the icon for the current node. |
| informationField | Defines the field which provides additional information. The placement of the information label varies between the ViewTemplates. The information label is only… |
| isCreatable | Creatable yes/no. |
| isDeletable | Deletable yes/no. |
| isEditable | Editable yes/no. |
| maxDBRow | Sets the maximum number of data rows to be gathered from the database |
| nodeExpandedField | Defines the field which defines if the node shall be initially expanded or not. |
| nodeTypeField | Defines the field which provides the type of the node. Possible values: NODE, DEFAULT. |
| parentField | Defines the entity field in which the ParentID is located. |
| rowspan | The rowspan of the element. |
| showChildrenCount | Defines if children count for a grouped row shall be shown. |
| title | Title of the component |
| titleField | Defines the field which provides the title for the current node. |
| useBreadCrumbs | 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 |
| 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. |
children
Type: Children
List of children in this container
colspan
Type: Integer
Default: 1
Constraints: Minimum: 0, Maximum: Integer.MAX_VALUE
The colspan of the element.
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
Defines the field which provides the description for the current node.
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
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
Defines if the actions shall be hidden.
hideContentSearch
Type: Boolean
Default: true
If true, the content search of the table is hidden.
iconField
Type: String
Defines the field which provides the icon for the current node.
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.
isCreatable
Type: Boolean
Default: true
Creatable yes/no.
isDeletable
Type: Boolean
Default: true
Deletable yes/no.
isEditable
Type: Boolean
Default: true
Editable yes/no.
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
Requires: parentField property group
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.
nodeTypeField
Type: String
Defines the field which provides the type of the node. Possible values: NODE, DEFAULT.
parentField
Type: String
Defines the entity field 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
Defines if children count for a grouped row shall be shown.
title
Type: String
Constraints: Verification: TITLE_LENGTH
Title of the component
titleField
Type: String
Defines the field which provides the title for the current node.
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 Mobilefalse- 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.