Difference between revisions of "Menu Item Object"
| Line 67: | Line 67: | ||
|- | |- | ||
| <code>data</code> || <code>string</code>{{pipe}}<code>object</code> || <code>null</code> || No || data-sort-value=0|0.1.0 || | | <code>data</code> || <code>string</code>{{pipe}}<code>object</code> || <code>null</code> || No || data-sort-value=0|0.1.0 || | ||
| − | The menu item data. This property is used to display the corresponding content. It can be indicated as | + | The menu item data. This property is used to display the corresponding content. It can be indicated as URL (<code>string</code>) or directly as content root object (<code>object</code>). If this property is not set, a default content page with headline ''"Content Not Available"'' is displayed. Please see [[Content Root Object]] for the data structure. |
| − | '''Note: Please note that it is also possible to indicate request actions instead of | + | '''Note: Please note that it is also possible to indicate request actions instead of URLs (e.g. <code>"request:interaction:{DATA_ID}@{URL}"</code>).''' |
|- | |- | ||
| <code>options</code> || <code>object</code> || <code>null</code> || No || data-sort-value=120|'''0.1.120''' || | | <code>options</code> || <code>object</code> || <code>null</code> || No || data-sort-value=120|'''0.1.120''' || | ||
Revision as of 15:10, 23 April 2021
{
"id": "menu_item_id",
"type": "default",
"display": true,
"enable": true,
"focus": false,
"execute": false,
"icon": "blank",
"image": "http://link.to.image",
"label": "Item Label",
"background": "http://link.to.image",
"extensionIcon": "blank",
"extensionLabel": "Extension Label",
"data": null,
"options": null
}
| Property | Type | Default Value | Mandatory | Since Version | Description |
|---|---|---|---|---|---|
id |
string |
null |
No | 0.1.0 |
The ID of the menu item. This property can be used to identify the item. The ID must be unique for the menu data and only consist of letters, numbers, and the special characters |
type |
string |
"default" |
No | 0.1.0 |
The type of the menu item.
|
display |
boolean |
true |
No | 0.1.0 |
Indicates if the menu item is displayed. This property can be used to temporarily remove items. |
enable |
boolean |
true |
No | 0.1.0 |
Indicates if the menu item is enabled. This property can be used to temporarily disable items. |
focus |
boolean |
false |
No | 0.1.0 |
Indicates if the menu item is focused. This property can be used to set the focus to a specific item. Note: If this property is set to true for multiple items, only the first item will get the focus. |
execute |
boolean |
false |
No | 0.1.120 |
Indicates if the menu item is automatically executed it on load. This property is part of the hidden features. For more information, please see Execute Property. |
icon |
string |
null |
No | 0.1.0 |
The icon of the menu item. Please see Icons for possible values. Note: Since version 0.1.130, this property is ignored if an |
image |
string |
null |
No | 0.1.130 |
The image of the menu item. This property can be used to display an image instead of an icon. The area of the image is 32x48 (WxH) pixels at layout resolution 720p (48x72 at 1080p). The image is sized to fill the entire width (by keeping the ratio) and is positioned in the center. |
label |
string |
null |
No | 0.1.0 |
The label of the menu or separator item. This property supports inline expressions. For more information, please see Inline Expressions. |
background |
string |
null |
No | 0.1.0 |
The background image that is used if no other background is set at lower levels. |
extensionIcon |
string |
null |
No | 0.1.0 |
The extension icon. This property can be used to display an additional icon on the right side of the menu item. Please see Icons for possible values. |
extensionLabel |
string |
null |
No | 0.1.0 |
The extension label. This property can be used to display an additional label on the right side of the menu item. This property is only used if no |
data |
string|object |
null |
No | 0.1.0 |
The menu item data. This property is used to display the corresponding content. It can be indicated as URL ( Note: Please note that it is also possible to indicate request actions instead of URLs (e.g. |
options |
object |
null |
No | 0.1.120 |
A special content page object that is displayed in a content panel if the menu item is selected and the menu button is pressed. The availability of options for the current selected item is indicated in the lower right corner of the content screen. Please see Content Page Object for the data structure. Since version 0.1.130, you can also set a content root object as options. Please see Content Root Object for the data structure. |