GridColumnList
Defined in: js-api/src/grid.ts:795
Represents grid columns.
Constructors
Constructor
new GridColumnList(
dart):GridColumnList
Defined in: js-api/src/grid.ts:798
Parameters
| Parameter | Type |
|---|---|
dart | any |
Returns
GridColumnList
Properties
| Property | Type | Defined in |
|---|---|---|
dart | any | js-api/src/grid.ts:796 |
Accessors
length
Get Signature
get length():
number
Defined in: js-api/src/grid.ts:832
GridColumnList length.
Returns
number
rowHeader
Get Signature
get rowHeader():
GridColumn<any> |null
Defined in: js-api/src/grid.ts:803
Row header column.
Returns
GridColumn<any> | null
Methods
add()
add(
options):GridColumn
Defined in: js-api/src/grid.ts:837
Adds a new column to the grid (but not to the underlying dataframe).
Parameters
| Parameter | Type |
|---|---|
options | { cellType: string; gridColumnName?: string; index?: number; } |
options.cellType | string |
options.gridColumnName? | string |
options.index? | number |
Returns
byIndex()
byIndex(
index):GridColumn<any> |null
Defined in: js-api/src/grid.ts:808
Returns a grid column by index, or null if it does not exist.
Parameters
| Parameter | Type |
|---|---|
index | number |
Returns
GridColumn<any> | null
byName()
byName(
columnName):GridColumn<any> |null
Defined in: js-api/src/grid.ts:813
Returns a grid column by name, or null if it does not exist.
Parameters
| Parameter | Type |
|---|---|
columnName | string |
Returns
GridColumn<any> | null
clear()
clear():
void
Defined in: js-api/src/grid.ts:845
Removes all columns.
Returns
void
removeAt()
removeAt(
index):void
Defined in: js-api/src/grid.ts:842
Removes a grid column at the specified position.
Parameters
| Parameter | Type |
|---|---|
index | number |
Returns
void
setOrder()
setOrder(
columnNames):void
Defined in: js-api/src/grid.ts:820
Sets column order. Sample: https://public.datagrok.ai/js/samples/grid/order/order-columns
Parameters
| Parameter | Type | Description |
|---|---|---|
columnNames | string[] | Order of columns. |
Returns
void
setVisible()
setVisible(
columnNames):void
Defined in: js-api/src/grid.ts:827
Shows the specified columns (and hides the rest). Sample: https://public.datagrok.ai/js/samples/grid/resize/hide-columns
Parameters
| Parameter | Type | Description |
|---|---|---|
columnNames | string[] | Names of the columns to show. |
Returns
void