Skip to main content

Class: GridColumn

dg.GridColumn

Represents a grid column

Constructors​

constructor​

• new GridColumn(dart)

Parameters​

NameType
dartany

Defined in​

src/grid.ts:601

Properties​

dart​

• dart: any

Defined in​

src/grid.ts:599

Accessors​

backColor​

• get backColor(): number

Background column as a 4-byte ARGB number.

Returns​

number

Defined in​

src/grid.ts:635

• set backColor(x): void

Parameters​

NameType
xnumber

Returns​

void

Defined in​

src/grid.ts:636

categoryColors​

• get categoryColors(): Object

Custom colors for categories. Sample: https://public.datagrok.ai/js/samples/grid/category-colors

Returns​

Object

Defined in​

src/grid.ts:658

• set categoryColors(x): void

Parameters​

NameType
xObject

Returns​

void

Defined in​

src/grid.ts:659

cellType​

• get cellType(): string

Returns​

string

Cell type.

Defined in​

src/grid.ts:644

• set cellType(x): void

Parameters​

NameType
xstring

Returns​

void

Defined in​

src/grid.ts:645

column​

• get column(): null | Column<any>

Returns​

null | Column<any>

Corresponding table column, or null.

Defined in​

src/grid.ts:615

editable​

• get editable(): boolean

Whether the column is editable.

Returns​

boolean

Defined in​

src/grid.ts:663

• set editable(x): void

Parameters​

NameType
xboolean

Returns​

void

Defined in​

src/grid.ts:664

format​

• get format(): string

Column format. Sample: https://public.datagrok.ai/js/samples/grid/html-markup-cells

Returns​

string

Defined in​

src/grid.ts:640

• set format(x): void

Parameters​

NameType
xstring

Returns​

void

Defined in​

src/grid.ts:641

grid​

• get grid(): Grid

A Grid this column is associated with

Returns​

Grid

Defined in​

src/grid.ts:610

idx​

• get idx(): number

Index of the column.

Returns​

number

Defined in​

src/grid.ts:621

isTextColorCoded​

• get isTextColorCoded(): boolean

isTextColorCoded. Whether to apply color to the text or background.

Returns​

boolean

Defined in​

src/grid.ts:683

• set isTextColorCoded(x): void

Parameters​

NameType
xboolean

Returns​

void

Defined in​

src/grid.ts:684

left​

• get left(): number

Left border (in pixels in the virtual viewport)

Returns​

number

Defined in​

src/grid.ts:687

name​

• get name(): string

Returns​

string

Column name.

Defined in​

src/grid.ts:626

• set name(x): void

Parameters​

NameType
xstring

Returns​

void

Defined in​

src/grid.ts:627

renderer​

• get renderer(): GridCellRenderer

Grid cell renderer.

Returns​

GridCellRenderer

Defined in​

src/grid.ts:648

• set renderer(x): void

Parameters​

NameType
xGridCellRenderer

Returns​

void

Defined in​

src/grid.ts:649

• get right(): number

Right border (in pixels in the virtual viewport)

Returns​

number

Defined in​

src/grid.ts:690

selected​

• get selected(): boolean

Whether the column is selected.

Returns​

boolean

Defined in​

src/grid.ts:667

• set selected(x): void

Parameters​

NameType
xboolean

Returns​

void

Defined in​

src/grid.ts:668

settings​

• get settings(): any

Grid column settings.

Returns​

any

Defined in​

src/grid.ts:696

• set settings(s): void

Parameters​

NameType
sany

Returns​

void

Defined in​

src/grid.ts:697

tags​

• get tags(): Object

Use this field to keep arbitrary auxiliary data. It is serialized as JSON, so be careful. See also temp.

Returns​

Object

Defined in​

src/grid.ts:700

temp​

• get temp(): Object

Use this field to keep auxiliary data. It is not serialized. See also tags.

Returns​

Object

Defined in​

src/grid.ts:703

tooltipColumns​

• get tooltipColumns(): string[]

Tooltip columns. Also requires tooltipType to be 'Columns'.

Returns​

string[]

Defined in​

src/grid.ts:679

• set tooltipColumns(x): void

Parameters​

NameType
xstring[]

Returns​

void

Defined in​

src/grid.ts:680

tooltipForm​

• get tooltipForm(): string

Tooltip form. Also requires tooltipType to be 'Form'.

Returns​

string

Defined in​

src/grid.ts:675

• set tooltipForm(x): void

Parameters​

NameType
xstring

Returns​

void

Defined in​

src/grid.ts:676

tooltipType​

• get tooltipType(): GridColumnTooltipType

Tooltip type, specific to this column.

Returns​

GridColumnTooltipType

Defined in​

src/grid.ts:671

• set tooltipType(x): void

Parameters​

NameType
xGridColumnTooltipType

Returns​

void

Defined in​

src/grid.ts:672

visible​

• get visible(): boolean

Column visibility.

Returns​

boolean

Defined in​

src/grid.ts:652

• set visible(x): void

Parameters​

NameType
xboolean

Returns​

void

Defined in​

src/grid.ts:653

width​

• get width(): number

Column width in pixels. Sample: https://public.datagrok.ai/js/samples/grid/resize-columns

Returns​

number

Defined in​

src/grid.ts:631

• set width(x): void

Parameters​

NameType
xnumber

Returns​

void

Defined in​

src/grid.ts:632

Methods​

checkEditable​

▸ checkEditable(): string

Returns null if column is editable, or the reason of not being editable, otherwise

Returns​

string

Defined in​

src/grid.ts:706

getDataWidth​

▸ getDataWidth(): number

Number of pixels required to render the longest element in the column.

Returns​

number

Defined in​

src/grid.ts:712

getVisibleCells​

▸ getVisibleCells(): Iterable<GridCell>

Returns all visible cells

Returns​

Iterable<GridCell>

Defined in​

src/grid.ts:693

move​

▸ move(position): void

Moves the specified column to the specified position

Parameters​

NameType
positionnumber

Returns​

void

Defined in​

src/grid.ts:709

scrollIntoView​

▸ scrollIntoView(): void

If this column is not entirely visible, scrolls the grid horizontally to show it.

Returns​

void

Defined in​

src/grid.ts:715

fromDart​

▸ Static fromDart(dart): null | GridColumn

Parameters​

NameType
dartany

Returns​

null | GridColumn

Defined in​

src/grid.ts:605