PropertyItem

Represents a label-value pair.

JSON Example

{
    "condition": "string",
    "drilldown_id": "string",
    "field": "string",
    "heading": false,
    "label": {
        "condition": "string",
        "hover": false,
        "icons": [
            {
                "color": "string",
                "placement": "string",
                "size": "number",
                "size_unit": "string",
                "tooltip": [
                    {
                        "condition": "string",
                        "heading": false,
                        "text": "string"
                    }
                ],
                "type": "string"
            }
        ],
        "navigation": "string",
        "text": "string"
    },
    "label_value_separator": "string",
    "navigation": "string",
    "render_configuration": [
        {
            "color": "string",
            "condition": "string",
            "display_value": "string",
            "icons": [
                {
                    "color": "string",
                    "placement": "string",
                    "size": "number",
                    "size_unit": "string",
                    "tooltip": [
                        {
                            "condition": "string",
                            "heading": false,
                            "text": "string"
                        }
                    ],
                    "type": "string"
                }
            ],
            "tooltip": [
                {
                    "condition": "string",
                    "heading": false,
                    "text": "string"
                }
            ]
        }
    ],
    "rowspan": 0,
    "separator": false,
    "span": 0,
    "style": {},
    "type": "string"
}

string

condition

Optional

Constraints: maxLength: 1024

If the condition is met then the property will be displayed. Examples of expression syntax are provided under 'example_request' section of 'CreateWidgetConfiguration' API.

string

drilldown_id

Optional

Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.

string

field

Required

Constraints: maxLength: 1024

Represents field value of the property.

boolean

heading

Optional

Set to true if the field is a heading. Default is false.

Label

label

Optional

Label that will be displayed for a UI element.

string

label_value_separator

Optional

Label value separator used between label and value. It can be any separator like ":" or "-".

string

navigation

Optional

Constraints: maxLength: 1024

Hyperlink of the specified UI page that provides details. This will be linked with value of the property.

array of RenderConfiguration

render_configuration

Optional

Render configuration to be applied, if any.

integer As int32 As int32

rowspan

Optional

Constraints: minimum: 1

Represent the vertical span of the widget / container

boolean

separator

Optional

If true, separates this property in a widget.

integer As int32 As int32

span

Optional

Constraints: minimum: 1 maximum: 12

Represent the horizontal span of the widget / container.

object

style

Optional

A style object applicable for the property item. It could be the any padding, margin style sheet applicable to the property item. A 'style' property is supported in case of layout 'AUTO' only.

string

type

Required

Constraints: maxLength: 255 default: String

Data type of the field.

Possible values are : String, Number, Date, Url,

Property Of

Header