Difference between revisions of "Content Page Object"
| (39 intermediate revisions by the same user not shown) | |||
| Line 4: | Line 4: | ||
"important": false, | "important": false, | ||
"wrap": false, | "wrap": false, | ||
| − | "transparent": | + | "compress": true, |
| + | "transparent": 0, | ||
"headline": "Page Headline", | "headline": "Page Headline", | ||
"background": "http://link.to.image", | "background": "http://link.to.image", | ||
"offset": "0,0,0,0", | "offset": "0,0,0,0", | ||
"items": [], | "items": [], | ||
| − | "options": null | + | "action": null, |
| + | "data": null, | ||
| + | "options": null, | ||
| + | "caption": "opt/menu", | ||
| + | "captionUnderlay": -1 | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
| + | |+ Property syntax of content page object | ||
|- | |- | ||
! Property !! Type !! Default Value !! Mandatory !! Since Version !! class="unsortable" | Description | ! Property !! Type !! Default Value !! Mandatory !! Since Version !! class="unsortable" | Description | ||
| Line 26: | Line 32: | ||
Indicates if the content page is wrapped. If this property is set to <code>true</code>, a corresponding menu can not be entered by using the navigation keys (i.e. left and right key). This property has no effect if the content is displayed in a panel, the content is not loaded via a menu, the content page is not the first or last one (if the content type is <code>"pages"</code>), or the content page is displayed as overlay/underlay page. | Indicates if the content page is wrapped. If this property is set to <code>true</code>, a corresponding menu can not be entered by using the navigation keys (i.e. left and right key). This property has no effect if the content is displayed in a panel, the content is not loaded via a menu, the content page is not the first or last one (if the content type is <code>"pages"</code>), or the content page is displayed as overlay/underlay page. | ||
|- | |- | ||
| − | | <code>transparent</code> || <code>boolean</code> || <code> | + | | <code>compress</code> || <code>boolean</code> || <code>true</code> || No || data-sort-value=123|'''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 <code>compress</code> property to <code>true</code>.''' | ||
| + | |||
| + | This property is part of the hidden features. For more information, please see [[Compress Property]]. | ||
| + | |- | ||
| + | | <code>transparent</code> || <code>number</code>{{pipe}}<code>boolean</code> || <code>0</code> || No || data-sort-value=142|'''0.1.142''' || | ||
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. | 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. | ||
| + | |||
| + | * <code>0</code>{{pipe}}<code>false</code>: The content background is not transparent. | ||
| + | * <code>1</code>{{pipe}}<code>true</code>: The content background is transparent. | ||
| + | * <code>2</code>: The content background is only transparent if no video/audio is active or the active video/audio has set the extended property <code>"control:transparent"</code> to <code>"true"</code>. For more information, please see [[Extended Properties]]. | ||
|- | |- | ||
| <code>headline</code> || <code>string</code> || <code>null</code> || No || data-sort-value=0|0.1.0 || | | <code>headline</code> || <code>string</code> || <code>null</code> || No || data-sort-value=0|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. | 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]]. | |
| − | This property supports | ||
|- | |- | ||
| <code>background</code> || <code>string</code> || <code>null</code> || No || data-sort-value=0|0.1.0 || | | <code>background</code> || <code>string</code> || <code>null</code> || No || data-sort-value=0|0.1.0 || | ||
| Line 53: | Line 69: | ||
| <code>items</code> || <code>array</code> || <code>null</code> || '''Yes''' || data-sort-value=0|0.1.0 || | | <code>items</code> || <code>array</code> || <code>null</code> || '''Yes''' || data-sort-value=0|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. | 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. | ||
| + | |- | ||
| + | | <code>action</code> || <code>string</code> || <code>null</code> || No || data-sort-value=112|'''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]]. | ||
| + | |- | ||
| + | | <code>data</code> || <code>object</code> || <code>null</code> || No || data-sort-value=112|'''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]]. | ||
|- | |- | ||
| <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''' || | ||
| − | 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. | + | 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 [[#top|Content Page Object]] for the data structure. |
| − | '''Note: If the selected content item has its own options property, this property is ignored.''' | + | Since version '''0.1.130''', you can also set a [[Content Root Object]] as options. |
| + | |||
| + | '''Note: If the selected content item has its own <code>options</code> property, this property is ignored.''' | ||
| + | |- | ||
| + | | <code>caption</code> || <code>string</code> || <code>"opt/menu"</code> || No || data-sort-value=130|'''0.1.130''' || | ||
| + | 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]]. | ||
| + | |- | ||
| + | | <code>captionUnderlay</code> || <code>number</code> || <code>-1</code> || No || data-sort-value=153|'''0.1.153''' || | ||
| + | The underlay of the content caption. This property can be used to explicitly set or remove the underlay of the content caption. The underlay is used to darken the lower part of the screen to make the caption more visible. By default, the underlay is used if a content list has overflowing items (i.e. content items are under the caption). This property has no effect if the content page is displayed as overlay/underlay page. | ||
| − | + | * <code>-1</code>: Automatically set/remove underlay. | |
| + | * <code>0</code>: Remove underlay. | ||
| + | * <code>1</code>: Set underlay. | ||
|} | |} | ||
| + | |||
| + | == Related Hidden Features == | ||
| + | * [[Page Action]] | ||
| + | * [[Compress Property]] | ||
| + | * [[Option Shortcut]] | ||
| + | |||
| + | == See also == | ||
| + | * [[Content Root Object]] | ||
| + | * [[Content Item Object]] | ||
| + | * [[Content Examples]] | ||
| + | * [[Content Guide]] | ||
Revision as of 10:29, 12 July 2023
{
"display": true,
"important": false,
"wrap": false,
"compress": true,
"transparent": 0,
"headline": "Page Headline",
"background": "http://link.to.image",
"offset": "0,0,0,0",
"items": [],
"action": null,
"data": null,
"options": null,
"caption": "opt/menu",
"captionUnderlay": -1
}
| 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 |
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. |
transparent |
number|boolean |
0 |
No | 0.1.142 |
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.
|
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. |
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. 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 |
captionUnderlay |
number |
-1 |
No | 0.1.153 |
The underlay of the content caption. This property can be used to explicitly set or remove the underlay of the content caption. The underlay is used to darken the lower part of the screen to make the caption more visible. By default, the underlay is used if a content list has overflowing items (i.e. content items are under the caption). This property has no effect if the content page is displayed as overlay/underlay page.
|