Difference between revisions of "Content Item Object"
Line 66: | Line 66: | ||
* <code>"space"</code>: Space items are not selectable and can be used to add background or foreground items. | * <code>"space"</code>: Space items are not selectable and can be used to add background or foreground items. | ||
* <code>"control"</code>: Control items are similar to "button" items and mainly designed for internal purposes (e.g. they are used in context menus and settings). The icon and label properties are typically used with this type. Additionally, the extensionLabel and extensionIcon properties are available for this type. | * <code>"control"</code>: Control items are similar to "button" items and mainly designed for internal purposes (e.g. they are used in context menus and settings). The icon and label properties are typically used with this type. Additionally, the extensionLabel and extensionIcon properties are available for this type. | ||
+ | |- | ||
+ | | <code>layout</code> || <code>string</code> || <code>"default"</code> || '''Only for the template object and non-templated items''' || data-sort-value=0|0.1.0 || | ||
+ | The layout of the content item in format <code>"x,y,w,h"</code>. This property is used to position the item on the layout grid. | ||
+ | '''Note: The grid size is 12x6 (or 8x6 for panels). It is not possible to register multiple items on the same position, however, it is possible to overlap items (e.g. to add background or foreground items of type <code>"space"</code>). If this property is set to the template object, only the <code>w</code> and <code>h</code> values are used. This property has no effect if it is set to a templated item.''' | ||
+ | |||
+ | The <code>x</code> value can go from <code>0</code> to <code>11</code> (or from <code>0</code> to <code>7</code> for panels). | ||
+ | The <code>y</code> value can go from <code>0</code> to <code>5</code>. | ||
+ | The <code>w</code> value can go from <code>1</code> to <code>12</code> (or from <code>1</code> to <code>8</code> for panels). | ||
+ | The <code>h</code> value can go from <code>1</code> to <code>6</code>. | ||
+ | |||
+ | All values are absolute integers. Please use the <code>offset</code> property to position items between the grid. | ||
|} | |} |
Revision as of 13:10, 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 |
type |
string |
"default" |
No | 0.1.0 |
The type of the content item.
|
layout |
string |
"default" |
Only for the template object and non-templated items | 0.1.0 |
The layout of the content item in format Note: The grid size is 12x6 (or 8x6 for panels). It is not possible to register multiple items on the same position, however, it is possible to overlap items (e.g. to add background or foreground items of type The All values are absolute integers. Please use the |