Difference between revisions of "Content Item Object"
(Created page with "<syntaxhighlight lang="json"> { "id": "content_item_id", "type": "default", "layout": "0,0,1,1", "area": "0,0,12,6", "offset": "0,0,0,0", "display":...") |
|||
| Line 56: | Line 56: | ||
| <code>id</code> || <code>string</code> || <code>null</code> || No || data-sort-value=0|0.1.0 || | | <code>id</code> || <code>string</code> || <code>null</code> || No || data-sort-value=0|0.1.0 || | ||
The ID of the content item. This property can be used to identify the item. The ID must be unique and only consist of letters, numbers, and the special characters <code>"_"</code>, <code>"-"</code>, <code>"."</code>. | The ID of the content item. This property can be used to identify the item. The ID must be unique and only consist of letters, numbers, and the special characters <code>"_"</code>, <code>"-"</code>, <code>"."</code>. | ||
| + | |- | ||
| + | | <code>version</code> || <code>string</code> || <code>null</code> || No || data-sort-value=0|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. | ||
| + | |- | ||
| + | | <code>flag</code> || <code>string</code> || <code>null</code> || No || data-sort-value=120|'''0.1.120''' || | ||
| + | A custom content flag that can be evaluated by plugins and/or servers. | ||
| + | |- | ||
| + | | <code>reuse</code> || <code>boolean</code> || <code>true</code> || No || data-sort-value=0|0.1.0 || | ||
| + | Indicates if the content data can be reused. If this property is set to <code>false</code>, the content data is recreated each time it is displayed. | ||
| + | |- | ||
| + | | <code>cache</code> || <code>boolean</code> || <code>true</code> || No || data-sort-value=58|'''0.1.58''' || | ||
| + | Indicates if the content data is restorable. If this property is set to <code>false</code>, 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 <code>restore</code> property to <code>false</code>, this property is ignored.''' | ||
|} | |} | ||
Revision as of 13:02, 11 January 2021
{
"id": "content_item_id",
"type": "default",
"layout": "0,0,1,1",
"area": "0,0,12,6",
"offset": "0,0,0,0",
"display": true,
"enable": true,
"focus": false,
"enumerate": false,
"group": "Item Group",
"color": "msx-glass",
"title": "Item Title",
"titleHeader": "Item Title Header",
"titleFooter": "Item Title Footer",
"label": "Item Label",
"icon": "blank",
"iconSize": "medium",
"headline": "Item Headline",
"text": "Item Text",
"alignment": "left",
"tag": "Item Tag",
"tagColor": "msx-red",
"badge": "Item Badge",
"badgeColor": "msx-green",
"progress": -1,
"progressColor": "msx-yellow",
"wrapperColor": "msx-blue",
"image": "http://link.to.image",
"imageFiller": "default",
"imageWidth": -1,
"imageHeight": -1,
"imageOverlay": -1,
"imagePreload": false,
"imageLabel": "Image Label",
"imageColor": "msx-black",
"imageScreenFiller": "fit",
"playerLabel": "Player Label",
"background": "http://link.to.image",
"extensionIcon": "blank",
"extensionLabel": "Extension Label",
"action": null,
"data": null,
"properties": null,
"live": null,
"selection": null,
"options": null
}
| Property | Type | Default Value | Mandatory | Since Version | Description |
|---|---|---|---|---|---|
id |
string |
null |
No | 0.1.0 |
The ID of the content item. This property can be used to identify the item. The ID must be unique and only consist of letters, numbers, and the special characters |
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 |
cache |
boolean |
true |
No | 0.1.58 |
Indicates if the content data is restorable. If this property is set to Note: If the content is loaded via a menu and the menu data has set the |