Difference between revisions of "Content Page Object"

From MSX - Wiki
Jump to navigation Jump to search
Line 38: Line 38:
 
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. For more information, please see [[Inline Expressions]].
+
This property supports inline expressions. For more information, please see '''[[Inline Expressions]]'''.
 
|-
 
|-
 
| <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 58: Line 58:
 
|-
 
|-
 
| <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''' ||  
 
| <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]].
+
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''' ||  
 
| <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]].
+
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''' ||  
Line 71: Line 71:
 
'''Note: If the selected content item has its own options property, this property is ignored.'''
 
'''Note: If the selected content item has its own options property, this property is ignored.'''
  
−
Please see [[#top|Content Page Object]] for the data structure.
+
Please see '''[[#top|Content Page Object]]''' for the data structure.
 
|}
 
|}
  

Revision as of 15:01, 12 January 2021

{   
    "display": true,
    "important": false,
    "wrap": false,
    "transparent": false,
    "compress": false,
    "headline": "Page Headline", 
    "background": "http://link.to.image",
    "offset": "0,0,0,0",
    "items": [],
    "action": null,
    "data": null,
    "options": null
}
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 true, a corresponding overlay/underlay page is hidden if the content page is active. If the content page is displayed as overlay/underlay page and this property is set to true, the page will never be hidden.

wrap boolean false No 0.1.102

Indicates if the content page is wrapped. If this property is set to true, 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 "pages"), or the content page is displayed as overlay/underlay page.

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 false No 0.1.123

Indicates if font size adjustments are performed when the content is compressed. 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 "x,y,w,h". This property can be used to add or subtract an offset.

Note: This property has no effect if the content type is "pages". If the content type is "list", only the y and h values are used. This property is ignored if this page is an overlay/underlay page.

The x value can go from -11.0 to 11.0 (or from -7.0 to 7.0 for panels).
The y value can go from -5.0 to 5.0.
The w value can go from -11.0 to 11.0 (or from -7.0 to 7.0 for panels).
The h value can go from -5.0 to 5.0.

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 -1.0 to 1.0.

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.

Note: If the selected content item has its own options property, this property is ignored.

Please see Content Page Object for the data structure.

Related Hidden Features[edit]

Retrieved from "https://msx.benzac.de/wiki/index.php?title=Content_Page_Object&oldid=213"