Difference between revisions of "Content Item Object"
Line 197: | Line 197: | ||
* <code>"text-justify"</code>: The text properties are aligned to fill the entire size. | * <code>"text-justify"</code>: The text properties are aligned to fill the entire size. | ||
* <code>"title-{ALIGNMENT}|text-{ALIGNMENT}"</code>: The title and text properties are aligned differently. The <code>{ALIGNMENT}</code> part must be replaced with the value <code>left</code>, <code>center</code>, <code>right</code>, or <code>justify</code>. | * <code>"title-{ALIGNMENT}|text-{ALIGNMENT}"</code>: The title and text properties are aligned differently. The <code>{ALIGNMENT}</code> part must be replaced with the value <code>left</code>, <code>center</code>, <code>right</code>, or <code>justify</code>. | ||
+ | |- | ||
+ | | <code>tag</code> || <code>string</code> || <code>null</code> || No || data-sort-value=0|0.1.0 || | ||
+ | The tag of the content item that is positioned in the upper right corner. | ||
+ | This property supports inline expressions. For more information, please see [[Inline Expressions]]. | ||
+ | |- | ||
+ | | <code>tagColor</code> || <code>string</code> || <code>null</code> || No || data-sort-value=0|0.1.0 || | ||
+ | The background color of the content tag. Please see [[Colors]] for possible values. | ||
+ | |- | ||
+ | | <code>badge</code> || <code>string</code> || <code>null</code> || No || data-sort-value=0|0.1.0 || | ||
+ | The badge of the content item that is positioned in the upper left corner. | ||
+ | This property supports inline expressions. For more information, please see [[Inline Expressions]]. | ||
+ | |- | ||
+ | | <code>badgeColor</code> || <code>string</code> || <code>null</code> || No || data-sort-value=0|0.1.0 || | ||
+ | The background color of the content badge. Please see [[Colors]] for possible values. | ||
+ | |- | ||
+ | | <code>progress</code> || <code>number</code> || <code>-1</code> || No || data-sort-value=70|'''0.1.70''' || | ||
+ | The progress of the content item that is shown as bar at the bottom. The value is a relative floating point number and can go from <code>0.0</code> to <code>1.0</code>. If this property is set to <code>-1</code>, the progress bar is not visible, but can be updated. If this property is not set at all, the progress bar is not visible and can not be updated. | ||
+ | |- | ||
+ | | <code>progressColor</code> || <code>string</code> || <code>null</code> || No || data-sort-value=70|'''0.1.70''' || | ||
+ | The color of the progress bar. Please see [[Colors]] for possible values. | ||
+ | |- | ||
+ | | <code>wrapperColor</code> || <code>string</code> || <code>null</code> || No || data-sort-value=70|'''0.1.70''' || | ||
+ | The color of the content wrapper (e.g. the color of the image space within the content item). To use this property, the content must be wrapped (e.g. the <code>imageWidth</code> or <code>imageHeight</code> property is set), otherwise this property is ignored. Please see [[Colors]] for possible values. | ||
+ | |- | ||
+ | | <code>image</code> || <code>string</code> || <code>null</code> || No || data-sort-value=0|0.1.0 || | ||
+ | The color of the content wrapper (e.g. the color of the image space within the content item). To use this property, the content must be wrapped (e.g. the <code>imageWidth</code> or <code>imageHeight</code> property is set), otherwise this property is ignored. Please see [[Colors]] for possible values. | ||
|} | |} |
Revision as of 13:40, 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 |
null |
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 |
area |
string |
null |
No | 0.1.110 |
The area used for created content items in the format The All values are absolute integers. Note: If this property is set, the possible |
offset |
string |
null |
No | 0.1.0 |
The offset of the content item in format The 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 |
display |
boolean |
true |
No | 0.1.0 |
Indicates if the content item is displayed. This property can be used to temporarily remove items. |
enable |
boolean |
true |
No | 0.1.0 |
Indicates if the content item is enabled. This property can be used to temporarily disable items. |
focus |
boolean |
false |
No | 0.1.0 |
Indicates if the content item is focused. This property can be used to set the focus to a specific item. Note: If this property is set to |
enumerate |
boolean |
true |false |
No | 0.1.0 |
Indicates if the content item is enumerated. Enumerated items can be executed in a row (e.g. to start a playlist or a slideshow). The default value is |
group |
string |
null |
No | 0.1.0 |
The group label of the content item if it is enumerated. This label is shown in the content headline after the enumeration info. If the group label starts with the string Note: Each group has its own enumeration counter. Therefore, if a group item is executed, only the related group items are executed in a row. To use this property, the This property supports inline expressions. For more information, please see Inline Expressions. |
color |
string |
null |
No | 0.1.0 |
The background color of the content item. Please see Colors for possible values. |
title |
string |
null |
No | 0.1.0 |
The title of the content item that is positioned in the lower left corner. Note: Since version 0.1.82, you can change the alignment of this content with the This property supports inline expressions. For more information, please see Inline Expressions. |
titleHeader |
string |
null |
No | 0.1.0 |
The title header of the content item that is positioned in the lower left corner. Note: Since version 0.1.82, you can change the alignment of this content with the This property supports inline expressions. For more information, please see Inline Expressions. |
titleFooter |
string |
null |
No | 0.1.0 |
The title footer of the content item that is positioned in the lower left corner. Note: Since version 0.1.82, you can change the alignment of this content with the This property supports inline expressions. For more information, please see Inline Expressions. |
label |
string |
null |
No | 0.1.0 |
The label of the content item that is positioned in the bottom center or on the left side if the item type is |
icon |
string |
null |
No | 0.1.0 |
The icon of the content item that is positioned in the center or on the left side if the item type is |
iconSize |
string |
"medium" |
No | 0.1.0 |
The size of the content icon.
|
headline |
string |
null |
No | 0.1.0 |
The headline of the content item that is positioned in the upper left corner. Note: Since version 0.1.82, you can change the alignment of this content with the This property supports inline expressions. For more information, please see Inline Expressions from the Common API. |
text |
string |array |
null |
No | 0.1.0 |
The text of the content item that is positioned in the upper left corner. By default, the text is indicated as single Note: Since version 0.1.82, you can change the alignment of this content with the This property supports inline expressions. For more information, please see Inline Expressions. |
alignment |
string |
"left" |
No | 0.1.82 |
The content alignment of the properties
Since version 0.1.97, you can also set separate alignments for the title (i.e.
|
tag |
string |
null |
No | 0.1.0 |
The tag of the content item that is positioned in the upper right corner. This property supports inline expressions. For more information, please see Inline Expressions. |
tagColor |
string |
null |
No | 0.1.0 |
The background color of the content tag. Please see Colors for possible values. |
badge |
string |
null |
No | 0.1.0 |
The badge of the content item that is positioned in the upper left corner. This property supports inline expressions. For more information, please see Inline Expressions. |
badgeColor |
string |
null |
No | 0.1.0 |
The background color of the content badge. Please see Colors for possible values. |
progress |
number |
-1 |
No | 0.1.70 |
The progress of the content item that is shown as bar at the bottom. The value is a relative floating point number and can go from |
progressColor |
string |
null |
No | 0.1.70 |
The color of the progress bar. Please see Colors for possible values. |
wrapperColor |
string |
null |
No | 0.1.70 |
The color of the content wrapper (e.g. the color of the image space within the content item). To use this property, the content must be wrapped (e.g. the |
image |
string |
null |
No | 0.1.0 |
The color of the content wrapper (e.g. the color of the image space within the content item). To use this property, the content must be wrapped (e.g. the |