Difference between revisions of "Content Root Object"
(Created page with "<syntaxhighlight lang="json"> { "name": "Content Name", "version": "1.0.0", "flag": "content_flag", "reuse": true, "cache": true, "restore": tru...") |
|||
Line 134: | Line 134: | ||
Please see [[Content Page Object]] for the data structure. | Please see [[Content Page Object]] for the data structure. | ||
|} | |} | ||
+ | |||
+ | == Related Hidden Features == | ||
+ | * [[Start Action]] | ||
+ | * [[Execute Property]] | ||
+ | * [[Focus Separator]] |
Revision as of 11:09, 11 January 2021
{
"name": "Content Name",
"version": "1.0.0",
"flag": "content_flag",
"reuse": true,
"cache": true,
"restore": true,
"important": false,
"wrap": false,
"transparent": false,
"type": "pages",
"preload": "none",
"headline": "Content Headline",
"background": "http://link.to.image",
"extension": "Content Extension",
"dictionary": "http://link.to.dictionary",
"template": null,
"items": [],
"pages": [],
"header": null,
"footer": null,
"overlay": null,
"underlay": null,
"options": null
}
Property | Type | Default Value | Mandatory | Since Version | Description |
---|---|---|---|---|---|
name |
string |
null |
No | 0.1.0 |
The name of the content. This property is only used if the content data is loaded at startup and can be used to set the content name. This value is displayed in the about panel of the Media Station X application. |
version |
string |
null |
No | 0.1.0 |
The version of the content. This property is only used if the content data is loaded at startup and can be used to add a content version. This value is displayed in the about panel of the Media Station X application. |
flag |
string |
null |
No | 0.1.120 |
A custom content flag that can be evaluated by plugins and/or servers. |
reuse |
boolean |
true |
No | 0.1.0 |
Indicates if the content data can be reused. If this property is set to false, the content data is recreated each time it is displayed. |
cache |
boolean |
true |
No | 0.1.58 |
Indicates if the content data is being cached. This property can be used to disable the cache feature. |
restore |
boolean |
true |
No | 0.1.120 |
Indicates if the content data is restorable. If this property is set to false, the content data is not restored when the application returns from a link action. This property has no effect if the content is displayed in a panel. Note: If the content is loaded via a menu and the menu data has set the |
important |
boolean |
false |
No | 0.1.58 |
Indicates if the content data is important. This property can be used to enforce that the content headline is displayed. Note: The content headline is not displayed if the content is loaded via a menu, because in that case the menu item label is used as headline. |
wrap |
boolean |
false |
No | 0.1.102 |
Indicates if the content data is wrapped. If this property is set to Note: If the active content page has its own |
type |
string |
"pages" |
No | 0.1.0 |
The type of the content items.
Note: If the |
preload |
string |
"none" |
No | 0.1.92 |
The preload mode of the content pages (available for type Note: Please use this feature wisely, because preloading pages can decrease the performance.
|
headline |
string |
null |
No | 0.1.0 |
The headline of the content. Note: This property has no effect if the content is loaded via a menu, because in that case the menu item label is used as headline. Since version 0.1.58, you can set the property 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. If the content data is loaded at startup, this background image is used as default. |
extension |
string |
null |
No | 0.1.82 |
The extension of the content screen. This property can be used to display a small label in the upper right corner of the content screen (e.g. to show the logged in user, the current date/time, etc.). This property supports inline expressions and live inline expressions. For more information about the inline expressions, please see Inline Expressions. For more information about the live inline expressions, please see Live Inline Expressions. |
dictionary |
string |
null |
No | 0.1.120 |
A link to a dictionary file. This property is only used if the content data is loaded at startup and can be used to setup a dictionary. A dictionary can be used to translate the application user interface. For more information, please see Dictionary Structure. |
template |
object |
null |
Only for templated items | 0.1.0 |
The template object to automatically create and position content items. Please see Content Item Object for the data structure. This property is mandatory if the content items should be automatically created and positioned. Note: Templated content items have all the same size and can be used to quickly create lists without having to deal with grid positions. To use this property, the |
items |
array |
null |
Only for templated items | 0.1.0 |
An array of content items. Please see Content Item Object for the data structure. This property is mandatory if the content items should be automatically created and positioned. Note: Templated content items only have to specify the relevant properties. The other properties are copied from the |
pages |
array |
null |
Only for non-templated items | 0.1.0 |
An array of content pages. Please see Content Page Object for the data structure. This property is mandatory if the content items should be manually created and positioned. Note: This property is ignored if a |
header |
object |
null |
No | 0.1.53 |
An individual header page for templated content items. Please see Content Page Object for the data structure. Note: To use this property, the |
footer |
object |
null |
No | 0.1.53 |
An individual footer page for templated content items. Please see Content Page Object for the data structure. Note: To use this property, the |
overlay |
object |
null |
No | 0.1.110 |
An independent overlay page that is displayed over each content page. Please see Content Page Object for the data structure. Note: For the overlay page, only items of type |
options |
object |
null |
No | 0.1.120 |
A special page object that is displayed in a panel if a content 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. This property is ignored if the content is displayed in a panel. Note: If the active content page or the selected content item has its own options property, this property is ignored. Please see Content Page Object for the data structure. |