Difference between revisions of "Content Page Object"
Line 82: | Line 82: | ||
This property is only used if the content page is set as <code>options</code> property and can be used to set a custom options caption (indicated in the lower right corner of the content screen). | This property is only used if the content page is set as <code>options</code> property and can be used to set a custom options caption (indicated in the lower right corner of the content screen). | ||
− | This property supports inline expressions. For more information, please see Inline Expressions. | + | This property supports inline expressions. For more information, please see [[Inline Expressions]]. |
|} | |} | ||
Revision as of 11:20, 2 March 2021
{
"display": true,
"important": false,
"wrap": false,
"transparent": false,
"compress": true,
"headline": "Page Headline",
"background": "http://link.to.image",
"offset": "0,0,0,0",
"items": [],
"action": null,
"data": null,
"options": null,
"caption": "opt/menu"
}
Property | Type | Default Value | Mandatory | Since Version | Description |
---|---|---|---|---|---|
display |
boolean |
true |
No | 0.1.0 |
Indicates if the content page is displayed. This property can be used to temporarily remove pages. |
important |
boolean |
false |
No | 0.1.110 |
Indicates if the content page is important. If this property is set to |
wrap |
boolean |
false |
No | 0.1.102 |
Indicates if the content page is wrapped. If this property is set to |
transparent |
boolean |
false |
No | 0.1.120 |
Indicates if the content background is transparent for this page. By default, the content background is set to a semi-transparent gray to darken the underlying video/image and make the content more visible. This property has no effect if the content is displayed in a panel or the content page is displayed as overlay/underlay page. |
compress |
boolean |
true |
No | 0.1.123 |
Indicates if font size adjustments are performed when the content is compressed. Note: This property is ignored if the corresponding content root object has not set the This property is part of the hidden features. For more information, please see Compress Property. |
headline |
string |
null |
No | 0.1.0 |
The headline of the content page. This headline is attached as sub-headline to the content headline. If the content does not have a headline, this headline is used for that. This property has no effect if the content page is displayed as overlay/underlay page. 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. This property has no effect if the content is displayed in a panel or the content page is displayed as overlay/underlay page. |
offset |
string |
null |
No | 0.1.0 |
The offset of the content page in format Note: This property has no effect if the content type is The All values are relative floating point numbers. Note: The offset values have been increased in version 0.1.110. In previous versions, each value can only go from |
items |
array |
null |
Yes | 0.1.0 |
An array of content items. Please see Content Item Object for the data structure. This property is mandatory, because without it, no content items can be displayed. |
action |
string |
null |
No | 0.1.112 |
The content page action that is executed if the page becomes active. This property is part of the hidden features. For more information, please see Page Action. |
data |
object |
null |
No | 0.1.112 |
The additional data of the content page action that is used if the action is executed. This property is part of the hidden features. For more information, please see Page Action. |
options |
object |
null |
No | 0.1.120 |
A special page object that is displayed in a panel if a content item from this page 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. This property is ignored if the content is displayed in a panel. 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. Note: If the selected content item has its own |
caption |
string |
"opt/menu" |
No | 0.1.130 |
This property is only used if the content page is set as This property supports inline expressions. For more information, please see Inline Expressions. |