Header
Header
Header of a widget that provides additional information. This will be shown at the container level. It includes details as label value pairs.
JSON Example
{
"condition": "string",
"content_alignment": "string",
"sub_header_widgets": [
{
"alignment": "string",
"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"
},
"rowspan": 0,
"separator": false,
"span": 0,
"weight": 0,
"widget_id": "string"
}
],
"sub_headers": [
{
"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 header will be applied. Examples of expression syntax are provided under 'example_request' section of 'CreateWidgetConfiguration' API.
string
content_alignment
Optional
Constraints:
default: RIGHT
Alignment of header labels.
Possible values are :
LEFT,
RIGHT,
array of
WidgetItem
sub_header_widgets
Optional
Constraints:
minItems: 0
An array of widgets which will appear inside the container header Instead of 'sub_headers' property use this property.
array of
PropertyItem
sub_headers
Optional
Constraints:
minItems: 0
An array of label-value properties. This field is deprecated instead used 'sub_header_widgets' property to define header widgets.