Skip to main content

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​

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…
childrenList of children in this container
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
parentFieldDefines the entity field in which the ParentID is located.
nodeTypeFieldDefines the field which provides the type of the node. Possible values: "NODE", "DEFAULT".
informationFieldDefines the field which provides additional information. The placement of the information label varies between the ViewTemplates. The information label is only…
nodeExpandedFieldDefines the field which defines if the node shall be initially expanded or not.
titleFieldDefines the field which provides the title for the current node.
descriptionFieldDefines the field which provides the description for the current node.
iconFieldDefines the field which provides the icon for the current node.
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…
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.
maxDBRowSets the maximum number of data rows to be gathered from the database
hideActionsDefines if the actions shall be hidden.
hideContentSearchIf true, the content search of the table is hidden.
showChildrenCountDefines if children count for a grouped row shall be shown.
expandRootItemsDefines if the items in the root level should be expanded initially.
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.
editRendererMappingMapping that specifies how an entity field should be rendered in edit mode. If no custom mapping is defined the default renderers are used.
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

List of children in this container

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.

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.

nodeTypeField​

Type: String

Defines the field which provides the type of the node. Possible values: "NODE", "DEFAULT".

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.

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.

titleField​

Type: String

Defines the field which provides the title for the current node.

descriptionField​

Type: String

Defines the field which provides the description for the current node.

iconField​

Type: String

Defines the field which provides the icon for the current node.

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.

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.

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

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.

showChildrenCount​

Type: Boolean
Default: true

Defines if children count for a grouped row shall be shown.

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.

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.

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.

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.