ColumnItem

Represents a column of the Grid


Properties

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.


string
drilldown_id Optional

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


string
field Required

Field from which values of the column will be derived.


boolean
hidden Optional

If set to true, hides the column


label Required

Label of the column.


string
navigation Optional

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


render_configuration Optional

Render configuration to be applied, if any.


boolean
sort_ascending Optional

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


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.


array of Tooltip
tooltip Optional

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


string
type Required

Data type of the field.

Possible values are: StringNumberDate

JSON Example

{
    "field": "string",
    "label": {
        "text": "string"
    },
    "type": "string"
}
Feedback

Was this page helpful?