Menu Root Object

From MSX - Wiki
Jump to navigation Jump to search
{ 
    "name": "Content Name",   
    "version": "1.0.0", 
    "reference": "http://link.to.menu", 
    "flag": "content_flag",  
    "reuse": true,
    "cache": true,
    "restore": true,
    "logo": "http://link.to.image",   
    "logoSize": "large",   
    "headline": "Menu Headline", 
    "background": "http://link.to.image",   
    "extension": "Content Extension", 
    "dictionary": "http://link.to.dictionary",
    "menu": [],
    "action": null,
    "data": null,
    "options": null    
}
Property syntax of menu root object
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 menu 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 menu 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.

reference string null No 0.1.134

The reference of the menu data. This property is only used if the menu data is loaded at startup and can be used to load the actual data (i.e. non-startup related data) from another location. This allows you to keep the start menu data more dynamic (e.g. by reloading it on the fly).

Note: Please note that most properties (e.g. logo, headline, menu, options, etc.) are ignored if this property is set, because the corresponding values are provided by the referenced data. Additionally, please note that it is also possible to indicate request actions instead of links (e.g. "request:interaction:{DATA_ID}@{URL}").

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 menu data can be reused. If this property is set to false, the menu data is recreated each time it is displayed.

cache boolean true No 0.1.58

Indicates if the menu data is being cached. This property can be used to disable the cache feature.

restore boolean true No 0.1.120

Indicates if the menu data is restorable. If this property is set to false, the menu data (and the related content data) is not restored when the application returns from a link action.

logo string null No 0.1.60

The logo image of the menu. This property can be used to display a logo instead of a headline. Please see property logoSize for the size of the area.

logoSize string "large" No 0.1.130

The size of the logo area of the menu.

  • "small": The area of the logo is 416x48 (WxH) pixels at layout resolution 720p (624x72 at 1080p).
  • "large": The area of the logo is 416x96 (WxH) pixels at layout resolution 720p (624x144 at 1080p).

The logo is sized to fill the entire height (by keeping the ratio) and is positioned on the left side.

Note: This property is ignored if no logo property is set.

headline string null No 0.1.0

The headline of the menu.

Note: Since version 0.1.60, this property is ignored if a logo property is set.

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 menu data is loaded at startup, this background image is used as default.

extension string null No 0.1.82

The extension of each corresponding content screen. This property can be used to display a small label in the upper right corner of each corresponding content screen (e.g. to show the logged in user, the current date/time, etc.). This property has no effect if the corresponding content contains its own extension.

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 menu 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.

menu array null Yes 0.1.0

An array of menu items. Please see Menu Item Object for the data structure. This property is mandatory, because without it, no menu items can be displayed.

action string null No 0.1.0

The start action that is executed if the menu data is loaded at startup. This property is part of the hidden features. For more information, please see Start Action.

data object null No 0.1.0

The additional data of the start action that is used if the action is executed. This property is part of the hidden features. For more information, please see Start Action.

options object null No 0.1.120

A special content page object that is displayed in a content panel if a 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.

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

Related Hidden Features[edit]

See also[edit]