Skip to main content

Interface: GridColumnBase

Defined in: model/field.ts:107

Every GridColumn key except its sizing. Split out so the sizing pair (width/flex) can join it as an exclusive union — here, and in Field.column below, each of which drops a different subset of these keys (#249).

Properties​

align?​

optional align?: ColumnAlign

Defined in: model/field.ts:110

columnRenderer?​

optional columnRenderer?: ColumnRenderer<unknown>

Defined in: model/field.ts:112

S5.7 — per-column, more specific than GanttOptions.gridCellRenderer.

field​

field: FieldKey

Defined in: model/field.ts:108

optional header?: string

Defined in: model/field.ts:109

headerRenderer?​

optional headerRenderer?: ColumnHeaderRenderer

Defined in: model/field.ts:116

Paints this column's header cell. It wins over the Gantt-wide headerRenderer for this column. The renderer may return only an icon or an inline SVG ({ html: '<svg …>' }). The library adds the header string as visually hidden text beside the output, so it stays the accessible name.

hidden?​

optional hidden?: boolean

Defined in: model/field.ts:129

true keeps this column declared but off the screen. The column holds its place in gridColumns, its width, and its position in the order, so showing it again puts it back where it was. It leaves the grid, ctx.view.resolvedColumns(), and the resize and reorder gestures. Default false. gantt.hideGridColumn(field) writes this key without a restatement of the whole list.

movable?​

optional movable?: boolean

Defined in: model/field.ts:123

Default true. A pinned column refuses the reorder drag and the move chord.

resizable?​

optional resizable?: boolean

Defined in: model/field.ts:121

Default true. A fixed column refuses the resize drag and the resize chord.

toggle?​

optional toggle?: true | ColumnToggle

Defined in: model/field.ts:119

Makes a boolean Field's cell a toggle. true takes the default look and the default write. Any other Field type throws ToggleFieldNotBooleanError where the column is declared.

tooltip?​

optional tooltip?: boolean

Defined in: model/field.ts:133

true adds this column's header and formatted value to the default bar tooltip. Default false. tooltip: true on an image column shows the stored URL unless the Field's formatValue returns a caption.