Class: GridColumnList

dg.GridColumnList

Represents grid columns.

Constructors

constructor

• new GridColumnList(dart)

Parameters

Name	Type
dart	any

Defined in

src/grid.ts:722

Properties

dart

• dart: any

Defined in

src/grid.ts:720

Accessors

length

• get length(): number

GridColumnList length.

Returns

number

Defined in

src/grid.ts:762

---

rowHeader

• get rowHeader(): null | GridColumn

Row header column.

Returns

null | GridColumn

Defined in

src/grid.ts:728

Methods

add

▸ add(options): GridColumn

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

Parameters

Name	Type
options	Object
options.cellType	string
options.gridColumnName?	string
options.index?	number

Returns

GridColumn

Defined in

src/grid.ts:767

---

byIndex

▸ byIndex(index): null | GridColumn

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

Parameters

Name	Type
index	number

Returns

null | GridColumn

Defined in

src/grid.ts:735

---

byName

▸ byName(columnName): null | GridColumn

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

Parameters

Name	Type
columnName	string

Returns

null | GridColumn

Defined in

src/grid.ts:742

---

setOrder

▸ setOrder(columnNames): void

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

Parameters

Name	Type	Description
columnNames	string[]	Order of columns.

Returns

void

Defined in

src/grid.ts:749

---

setVisible

▸ setVisible(columnNames): void

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

Parameters

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

Returns

void

Defined in

src/grid.ts:756