Difference between revisions of "Content Item Object"

From MSX - Wiki
Jump to navigation Jump to search
Line 67: Line 67:
 
* <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 ||  
+
| <code>layout</code> || <code>string</code> || <code>null</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.
 
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.'''
 
'''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>x</code> value can go from <code>0</code> to <code>11</code> (or from <code>0</code> to <code>7</code> for panels).<br/>
−
The <code>y</code> value can go from <code>0</code> to <code>5</code>.
+
The <code>y</code> value can go from <code>0</code> to <code>5</code>.<br/>
−
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>w</code> value can go from <code>1</code> to <code>12</code> (or from <code>1</code> to <code>8</code> for panels).<br/>
−
The <code>h</code> value can go from <code>1</code> to <code>6</code>.
+
The <code>h</code> value can go from <code>1</code> to <code>6</code>.<br/>
  
 
All values are absolute integers. Please use the <code>offset</code> property to position items between the grid.
 
All values are absolute integers. Please use the <code>offset</code> property to position items between the grid.
 +
|-
 +
| <code>area</code> || <code>string</code> || <code>null</code> || No || data-sort-value=110|'''0.1.110''' ||
 +
The area used for created content items in the format <code>"x,y,w,h"</code>. This property can only be used inside the template object and is used to specify the area in which the created items can be positioned. It is typically used with an overlay/underlay page to keep a specific area clear of content.
 +
 +
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).<br/>
 +
The <code>y</code> value can go from <code>0</code> to <code>5</code>.<br/>
 +
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).<br/>
 +
The <code>h</code> value can go from <code>1</code> to <code>6</code>.<br/>
 +
 +
All values are absolute integers.
 +
 +
'''Note: If this property is set, the possible <code>w</code> and <code>h</code> values of the layout property are changed accordingly.'''
 +
|-
 +
| <code>offset</code> || <code>string</code> || <code>null</code> || No || data-sort-value=0|0.1.0 ||
 +
The offset of the content item in format <code>"x,y,w,h"</code>. This property can be used to add or subtract an offset.
 +
 +
The <code>x value can go from <code>-11.0</code> to <code>11.0</code> (or from <code>-7.0</code> to <code>7.0</code> for panels).
 +
The <code>y value can go from <code>-5.0</code> to <code>5.0</code>.
 +
The <code>w value can go from <code>-11.0</code> to <code>11.0</code> (or from <code>-7.0</code> to <code>7.0</code> for panels).
 +
The <code>h value can go from <code>-5.0</code> to <code>5.0</code>.
 +
 +
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 <code>-1.0</code> to <code>1.0</code>.'''
 
|}
 
|}

Revision as of 13:15, 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.

  • "default": Default item.
  • "teaser": Teaser items are similar to "default" items, but they have a larger title.
  • "button": Button items have a frame and a transparent background color. The icon and label properties are typically used with this type.
  • "separate": Separate items have seperated titles.
  • "space": Space items are not selectable and can be used to add background or foreground items.
  • "control": 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.
layout string null Only for the template object and non-templated items 0.1.0

The layout of the content item in format "x,y,w,h". 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 "space"). If this property is set to the template object, only the w and h values are used. This property has no effect if it is set to a templated item.

The x value can go from 0 to 11 (or from 0 to 7 for panels).
The y value can go from 0 to 5.
The w value can go from 1 to 12 (or from 1 to 8 for panels).
The h value can go from 1 to 6.

All values are absolute integers. Please use the offset property to position items between the grid.

area string null No 0.1.110

The area used for created content items in the format "x,y,w,h". This property can only be used inside the template object and is used to specify the area in which the created items can be positioned. It is typically used with an overlay/underlay page to keep a specific area clear of content.

The x value can go from 0 to 11 (or from 0 to 7 for panels).
The y value can go from 0 to 5.
The w value can go from 1 to 12 (or from 1 to 8 for panels).
The h value can go from 1 to 6.

All values are absolute integers.

Note: If this property is set, the possible w and h values of the layout property are changed accordingly.

offset string null No 0.1.0

The offset of the content item in format "x,y,w,h". This property can be used to add or subtract an offset.

The x value can go from -11.0 to 11.0 (or from -7.0 to 7.0 for panels). The y value can go from -5.0 to 5.0. The w value can go from -11.0 to 11.0 (or from -7.0 to 7.0 for panels). The h value can go from -5.0 to 5.0.

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 -1.0 to 1.0.

Retrieved from "https://msx.benzac.de/wiki/index.php?title=Content_Item_Object&oldid=145"