ColumnItem

ColumnItem

Represents a column of the Grid

JSON Example

{
    "sort_key": "string",
    "type": "string",
    "tooltip": [
        {
            "text": "string",
            "condition": "string"
        }
    ],
    "label": {
        "text": "string",
        "hover": false,
        "navigation": "string",
        "condition": "string",
        "icons": [
            {
                "placement": "string",
                "type": "string",
                "tooltip": [
                    {
                        "text": "string",
                        "condition": "string"
                    }
                ]
            }
        ]
    },
    "field": "string",
    "sort_ascending": false,
    "drilldown_id": "string",
    "hidden": false,
    "navigation": "string",
    "column_identifier": "string",
    "render_configuration": [
        {
            "color": "string",
            "condition": "string",
            "display_value": "string",
            "tooltip": [
                {
                    "text": "string",
                    "condition": "string"
                }
            ],
            "icons": [
                {
                    "placement": "string",
                    "type": "string",
                    "tooltip": [
                        {
                            "text": "string",
                            "condition": "string"
                        }
                    ]
                }
            ]
        }
    ]
}

string

sort_key

Optional

Sorting on column is based on the sort_key. sort_key represents the field in the output data on which sort is requested.

string

type

Required

Data type of the field.

Possible values are : String, Number, Date,

array of Tooltip

tooltip

Optional

Multi-line text to be shown on tooltip while hovering over a cell in the grid.

Label

label

Required

label

string

field

Required

Field from which values of the column will be derived.

boolean

sort_ascending

Optional

If true, the value of the column are sorted in ascending order. Otherwise, in descending order.

string

drilldown_id

Optional

Id of drilldown widget, if any. Id should be a valid id of an existing widget.

boolean

hidden

Optional

If set to true, hides the column

string

navigation

Optional

Hyperlink of the specified UI page that provides details. If drilldown_id is provided, then navigation cannot be used.

string

column_identifier

Optional

Identifies the column and used for fetching content upon an user click or drilldown. If column identifier is not provided, the column's data will not participate in searches and drilldowns.

array of RenderConfiguration

render_configuration

Optional

Render configuration to be applied, if any.