Skip to main content

FavoriteViewTemplate

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

Displays an area including a standard "favorite tag" button and provides additional tag fields to add the current dataset to specific favorite groups.

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…
objectTypeField which stores the objectType of the favorite
rowIdField which stores the rowId of the favorite
entityFieldThis property is mandatory. Its value must be set to
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.


objectType

Type: String

Field which stores the objectType of the favorite


rowId

Type: String

Field which stores the rowId of the favorite


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.

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.