Skip to main content

Class: GridCell

dg.GridCell

Represents a grid cell

Constructors

constructor

new GridCell(dart)

Parameters

NameType
dartany

Defined in

src/grid.ts:487

Properties

dart

dart: any

Defined in

src/grid.ts:485

Accessors

bounds

get bounds(): Rect

Grid cell bounds. Sample: https://public.datagrok.ai/js/samples/grid/cell-bounds

Returns

Rect

Defined in

src/grid.ts:571


cell

get cell(): Cell

Returns

Cell

Corresponding table cell.

Defined in

src/grid.ts:556


cellType

get cellType(): string

Returns

string

Cell type

Defined in

src/grid.ts:502


color

get color(): number

Calculates cell background color, according to color-coding.

Returns

number

Defined in

src/grid.ts:566


customText

get customText(): string

Custom text to be shown in a cell .

Returns

string

Defined in

src/grid.ts:547

set customText(x): void

Parameters

NameType
xstring

Returns

void

Defined in

src/grid.ts:548


documentBounds

get documentBounds(): Rect

Grid cell bounds, relative to the document. Useful for showing hints, tooltips, etc.

Returns

Rect

Defined in

src/grid.ts:576


element

get element(): HTMLElement

Gets or sets HTML element for this grid cell.

Returns

HTMLElement

Defined in

src/grid.ts:588

set element(e): void

Parameters

NameType
eHTMLElement

Returns

void

Defined in

src/grid.ts:589


grid

get grid(): Grid

Returns

Grid

this cell belongs to.

Defined in

src/grid.ts:551


gridColumn

get gridColumn(): GridColumn

Returns

GridColumn

Corresponding grid column.

Defined in

src/grid.ts:542


gridRow

get gridRow(): number

Returns

number

Index of the corresponding grid row.

Defined in

src/grid.ts:537


isColHeader

get isColHeader(): boolean

Returns

boolean

Whether this is a column header.

Defined in

src/grid.ts:517


isRowHeader

get isRowHeader(): boolean

Returns

boolean

Whether this is a row header.

Defined in

src/grid.ts:512


isTableCell

get isTableCell(): boolean

Returns

boolean

Whether this is a table (data) cell (as opposed to special cells like row headers).

Defined in

src/grid.ts:507


renderer

get renderer(): GridCellRenderer

Returns grid cell renderer.

Returns

GridCellRenderer

Defined in

src/grid.ts:583


style

get style(): GridCellStyle

Returns

GridCellStyle

Style to use for rendering.

Defined in

src/grid.ts:561


tableColumn

get tableColumn(): null | Column<any>

Returns

null | Column<any>

Corresponding table column, or null.

Defined in

src/grid.ts:522


tableRow

get tableRow(): null | Row

Returns

null | Row

Corresponding table row, or null.

Defined in

src/grid.ts:527


tableRowIndex

get tableRowIndex(): null | number

Returns

null | number

Index of the corresponding table row.

Defined in

src/grid.ts:532

Methods

setValue

setValue(x, notify?): void

Sets the grid cell value and fires onCellValueEdited if notify is true

Parameters

NameTypeDefault value
xanyundefined
notifybooleantrue

Returns

void

Defined in

src/grid.ts:592


fromColumnRow

Static fromColumnRow(grid, columnName, gridRow): GridCell

Parameters

NameType
gridGrid
columnNamestring
gridRownumber

Returns

GridCell

Defined in

src/grid.ts:492


fromValue

Static fromValue(value): GridCell

Returns a synthecic GridCell that only contains value but no row/col. Useful for rendering values.

Parameters

NameType
valueany

Returns

GridCell

Defined in

src/grid.ts:497