GridColumnList

Represents grid columns.

Constructors

new GridColumnList()

new GridColumnList(dart): GridColumnList

Parameters

Parameter	Type
dart	any

Returns

GridColumnList

Source

src/grid.ts:799

Properties

Property	Type
dart	any

Accessors

length

get length(): number

GridColumnList length.

Returns

number

Source

src/grid.ts:839

---

rowHeader

get rowHeader(): null | GridColumn<any>

Row header column.

Returns

null | GridColumn<any>

Source

src/grid.ts:805

Methods

add()

add(options): GridColumn<any>

Adds a new column to the grid (but not to the underlying dataframe).

Parameters

Parameter	Type
options	object
options.cellType	string
options.gridColumnName?	string
options.index?	number

Returns

GridColumn<any>

Source

src/grid.ts:844

---

byIndex()

byIndex(index): null | GridColumn<any>

Returns a grid column by index, or null if it does not exist.

Parameters

Parameter	Type	Description
index	number

Returns

null | GridColumn<any>

Source

src/grid.ts:812

---

byName()

byName(columnName): null | GridColumn<any>

Returns a grid column by name, or null if it does not exist.

Parameters

Parameter	Type	Description
columnName	string

Returns

null | GridColumn<any>

Source

src/grid.ts:819

---

clear()

clear(): void

Removes all columns.

Returns

void

Source

src/grid.ts:852

---

removeAt()

removeAt(index): void

Removes a grid column at the specified position.

Parameters

Parameter	Type
index	number

Returns

void

Source

src/grid.ts:849

---

setOrder()

setOrder(columnNames): void

Sets column order. Sample: https://public.datagrok.ai/js/samples/grid/order-columns

Parameters

Parameter	Type	Description
columnNames	string[]	Order of columns.

Returns

void

Source

src/grid.ts:826

---

setVisible()

setVisible(columnNames): void

Shows the specified columns (and hides the rest). Sample: https://public.datagrok.ai/js/samples/grid/hide-columns

Parameters

Parameter	Type	Description
columnNames	string[]	Names of the columns to show.

Returns

void

Source

src/grid.ts:833