ColumnDesc

Interface: ColumnDesc

taipy-gui JS module API

---

taipy-gui JS module API / ColumnDesc

A column description as received by the backend.

Properties

apply?

optional apply: string

The name of the aggregation function.

---

className?

optional className: string

The name of the column that holds the CSS className to apply to the cells.

---

dfid

dfid: string

The unique column identifier.

---

filter?

optional filter: boolean

The flag that allows filtering.

---

format?

optional format: string

The value format.

---

formatFn?

optional formatFn: string

The name of the column that holds the formatted value to show on the cells.

---

freeLov?

optional freeLov: boolean

If true the user can enter any value besides the lov values.

---

groupBy?

optional groupBy: boolean

The flag that allows the user to aggregate the column.

---

index

index: number

The order of the column.

---

lineBreak?

optional lineBreak: boolean

If true or not set, line breaks are transformed into
.

---

lov?

optional lov: string[]

The list of values that can be used on edit.

---

nanValue?

optional nanValue: string

The value that would replace a NaN value.

---

notEditable?

optional notEditable: boolean

If true, the column cannot be edited.

---

sortable?

optional sortable: boolean

If false, the column cannot be sorted

---

title?

optional title: string

The column title.

---

tooltip?

optional tooltip: string

The name of the column that holds the tooltip to show on the cells.

---

type

type: string

The column type.

---

tz?

optional tz: string

The TimeZone identifier used if the type is date.

---

width?

optional width: string | number

The column width.