Skip to main content

CardViewTemplate

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

Displays up to 5 entity fields of one single dataset, styled like a business card. All fields have fixed positions: On the left, an image (property "iconField"), on the right 4 further fields, in vertical order (properties "titleField", "subtitleField", "descriptionField", and "informationField").

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…
favoriteAction1First actiongroup for additional actions
favoriteAction2Second actiongroup for additional actions
entityFieldThis property is mandatory. Its value must be set to
objectTypeField which stores the objectType of the favorite
rowIdField which stores the rowId of the favorite
iconFieldField, which determines the icon
titleFieldField, which holds the title
subtitleFieldField, which hold an additional title. Shown below the title.
descriptionFieldField, which holds the description text
informationFieldDefines the field which provides additional information. The placement of the information label varies between the ViewTemplates. The information label is only…
isEditableEditable yes/no.
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.

favoriteAction1​

Type: String

First actiongroup for additional actions

favoriteAction2​

Type: String

Second actiongroup for additional actions

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.

objectType​

Type: String

Field which stores the objectType of the favorite

rowId​

Type: String

Field which stores the rowId of the favorite

iconField​

Type: String

Field, which determines the icon

titleField​

Type: String

Field, which holds the title

subtitleField​

Type: String

Field, which hold an additional title. Shown below the title.

descriptionField​

Type: String

Field, which holds the description text

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.

isEditable​

Type: Boolean
Default: true

Editable yes/no.

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.