Class: Grid

dg.Grid

High-performance, flexible spreadsheet control

Hierarchy

Viewer<IGridLookSettings>
↳ Grid

Constructors

constructor

• new Grid(dart)

Parameters

Name	Type
`dart`	`any`

Overrides

Viewer.constructor

Defined in

src/grid.ts:827

Properties

_properties

• Protected _properties: Property[]

Inherited from

Viewer._properties

Defined in

src/widgets.ts:178

_root

• Protected _root: HTMLElement

Inherited from

Viewer._root

Defined in

src/widgets.ts:177

dart

• dart: any

Inherited from

Viewer.dart

Defined in

src/widgets.ts:181

factory

• factory: null | Func = null

Constructor function. No parameters, returns [Widget].

Inherited from

Viewer.factory

Defined in

src/widgets.ts:175

filter

• filter: BitSet

Inherited from

Viewer.filter

Defined in

src/viewer.ts:70

isDetached

• isDetached: boolean = false

subs

• subs: Subscription[]

Inherited from

Viewer.subs

Defined in

src/widgets.ts:180

temp

• temp: any

Contains auxiliary information

Inherited from

Viewer.temp

Defined in

src/widgets.ts:172

Accessors

canvas

• get canvas(): HTMLCanvasElement

Returns

HTMLCanvasElement

Defined in

src/grid.ts:872

colHeaderBox

• get colHeaderBox(): Rect

Column labels box

Returns

Rect

Defined in

src/grid.ts:994

colHeaderHeight

• get colHeaderHeight(): number

Column labels height

Returns

number

Defined in

src/grid.ts:986

columns

• get columns(): GridColumnList

Grid columns.

Returns

GridColumnList

Defined in

src/grid.ts:848

dataFrame

• get dataFrame(): DataFrame

Returns

DataFrame

Inherited from

Viewer.dataFrame

Defined in

src/viewer.ts:175

• set dataFrame(t): void

Parameters

Name	Type
`t`	`DataFrame`

Returns

void

Inherited from

Viewer.dataFrame

Defined in

src/viewer.ts:179

helpUrl

• get helpUrl(): string

Returns

string

Inherited from

Viewer.helpUrl

Defined in

src/viewer.ts:183

• set helpUrl(s): void

Parameters

Name	Type
`s`	`string`

Returns

void

Inherited from

Viewer.helpUrl

Defined in

src/viewer.ts:187

horzScroll

• get horzScroll(): RangeSlider

Horizontal scroll bar

Returns

RangeSlider

Defined in

src/grid.ts:981

onAfterDrawContent

• get onAfterDrawContent(): Observable<EventData<any>>

Returns

Observable<EventData<any>>

Defined in

src/grid.ts:1032

onAfterDrawOverlay

• get onAfterDrawOverlay(): Observable<EventData<any>>

Returns

Observable<EventData<any>>

Defined in

src/grid.ts:1030

onBeforeDrawContent

• get onBeforeDrawContent(): Observable<EventData<any>>

Returns

Observable<EventData<any>>

Defined in

src/grid.ts:1031

onBeforeDrawOverlay

• get onBeforeDrawOverlay(): Observable<EventData<any>>

Returns

Observable<EventData<any>>

Defined in

src/grid.ts:1029

onCellClick

• get onCellClick(): Observable<GridCell>

Returns

Observable<GridCell>

Defined in

src/grid.ts:1023

onCellDoubleClick

• get onCellDoubleClick(): Observable<GridCell>

Returns

Observable<GridCell>

Defined in

src/grid.ts:1024

onCellKeyDown

• get onCellKeyDown(): Observable<GridCell>

Returns

Observable<GridCell>

Defined in

src/grid.ts:1026

onCellMouseDown

• get onCellMouseDown(): Observable<GridCell>

Returns

Observable<GridCell>

Defined in

src/grid.ts:1025

onCellMouseEnter

• get onCellMouseEnter(): Observable<GridCell>

Returns

Observable<GridCell>

Defined in

src/grid.ts:1020

onCellMouseLeave

• get onCellMouseLeave(): Observable<GridCell>

Returns

Observable<GridCell>

Defined in

src/grid.ts:1021

onCellRender

• get onCellRender(): Observable<GridCellRenderArgs>

Sample: https://public.datagrok.ai/js/samples/grid/custom-cell-rendering-indexes

Returns

Observable<GridCellRenderArgs>

Defined in

src/grid.ts:867

onCellValueEdited

• get onCellValueEdited(): Observable<GridCell>

Returns

Observable<GridCell>

Defined in

src/grid.ts:1018

onColumnResized

• get onColumnResized(): Observable<any>

Sample: https://public.datagrok.ai/js/samples/grid/resize-events

Returns

Observable<any>

Defined in

src/grid.ts:1007

onContextMenu

• get onContextMenu(): Observable<Menu>

Returns

Observable<Menu>

Inherited from

Viewer.onContextMenu

Defined in

src/viewer.ts:284

onCurrentCellChanged

• get onCurrentCellChanged(): Observable<GridCell>

Returns

Observable<GridCell>

Defined in

src/grid.ts:1019

onDartPropertyChanged

• get onDartPropertyChanged(): Observable<null>

Returns

Observable<null>

Inherited from

Viewer.onDartPropertyChanged

Defined in

src/viewer.ts:310

onDataEvent

• get onDataEvent(): Observable<ViewerEvent>

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onDataEvent

Defined in

src/viewer.ts:78

onDataHovered

• get onDataHovered(): Observable<ViewerEvent>

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onDataHovered

Defined in

src/viewer.ts:79

onDataRowClicked

• get onDataRowClicked(): Observable<ViewerEvent>

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onDataRowClicked

Defined in

src/viewer.ts:82

onDataSelected

• get onDataSelected(): Observable<ViewerEvent>

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onDataSelected

Defined in

src/viewer.ts:80

onGridCellLinkClicked

• get onGridCellLinkClicked(): Observable<EventData<GridCellArgs>>

Returns

Observable<EventData<GridCellArgs>>

Defined in

src/grid.ts:1034

onPinnedRowsChanged

• get onPinnedRowsChanged(): Observable<any>

Returns

Observable<any>

Defined in

src/grid.ts:1016

onRowEnter

• get onRowEnter(): Observable<GridCell>

Returns

Observable<GridCell>

Defined in

src/grid.ts:1027

onRowsResized

• get onRowsResized(): Observable<any>

Sample: https://public.datagrok.ai/js/samples/grid/resize-events

Returns

Observable<any>

Defined in

src/grid.ts:1012

onRowsSorted

• get onRowsSorted(): Observable<any>

Sample: https://public.datagrok.ai/js/samples/grid/order-rows

Returns

Observable<any>

Defined in

src/grid.ts:1015

overlay

• get overlay(): HTMLCanvasElement

Returns

HTMLCanvasElement

Defined in

src/grid.ts:877

pinnedRows

• get pinnedRows(): Iterable<number>

Pinned rows.

Returns

Iterable<number>

Defined in

src/grid.ts:944

root

• get root(): HTMLElement

Visual root.

Returns

HTMLElement

Inherited from

Viewer.root

Defined in

src/viewer.ts:144

sortByColumns

• get sortByColumns(): Column<any>[]

List of columns the grid is sorted by.

Returns

Column<any>[]

Defined in

src/grid.ts:882

sortTypes

• get sortTypes(): boolean[]

Sort directions for [sortByColumns]: true = ascending order, false = descending order.

Returns

boolean[]

Defined in

src/grid.ts:885

table

• get table(): DataFrame

Returns

DataFrame

Inherited from

Viewer.table

Defined in

src/viewer.ts:160

tableView

• get tableView(): null | TableView

Returns a view this viewer is associated with, or null

Returns

null | TableView

Inherited from

Viewer.tableView

Defined in

src/viewer.ts:170

type

• get type(): string

Returns viewer type (see VIEWER constants)

Returns

string

Inherited from

Viewer.type

Defined in

src/viewer.ts:156

vertScroll

• get vertScroll(): RangeSlider

Vertical scroll bar. Sample: https://public.datagrok.ai/js/samples/grid/scroll-bars

Returns

RangeSlider

Defined in

src/grid.ts:970

view

• get view(): null | View

Returns a view this viewer is associated with, or null

Returns

null | View

Inherited from

Viewer.view

Defined in

src/viewer.ts:165

Methods

addProperty

▸ Private addProperty(propertyName, propertyType, defaultValue?, options?): any

Registers an property with the specified type, name, and defaultValue. Registered property gets added to {@see properties}. Returns default value, thus allowing to combine registering a property with the initialization

Parameters

Name	Type	Default value
`propertyName`	`string`	`undefined`
`propertyType`	`"string"` \| `"bigint"` \| `"object"` \| `"map"` \| `"file"` \| `"view"` \| `"element"` \| `"int"` \| `"double"` \| `"bool"` \| `"byte_array"` \| `"datetime"` \| `"qnum"` \| `"dataframe"` \| `"num"` \| `"string_list"` \| `"dataframe_list"` \| `"cell"` \| `"column"` \| `"column_list"` \| `"graphics"` \| `"tablerowfiltercall"` \| `"colfiltercall"` \| `"bitset"` \| `"dynamic"` \| `"viewer"` \| `"list"` \| `"semantic_value"` \| `"func"` \| `"funccall"` \| `"property"` \| `"categorical"` \| `"numerical"` \| `"GridCellRenderArgs"` \| `"TableView"` \| `"User"` \| `"Menu"` \| `"Project"` \| `"event_data"` \| `"progressindicator"` \| `"Credentials"` \| `"ScriptEnvironment"` \| `"Notebook"`	`undefined`
`defaultValue`	`any`	`null`
`options`	`null` \| { `[key: string]`: `any`; } & `PropertyOptions`	`null`

Returns

any

Inherited from

Viewer.addProperty

Defined in

src/widgets.ts:280

apply

▸ apply(properties): Widget<any>

Parameters

Name	Type
`properties`	`object`

Returns

Widget<any>

Inherited from

Viewer.apply

Defined in

src/widgets.ts:230

autoSize

▸ autoSize(maxWidth, maxHeight, minWidth?, minHeight?, autoSizeOnDataChange?): void

Resizes the grid to fit the content

Parameters

Name	Type
`maxWidth`	`number`
`maxHeight`	`number`
`minWidth?`	`number`
`minHeight?`	`number`
`autoSizeOnDataChange?`	`boolean`

Returns

void

Defined in

src/grid.ts:1042

cell

▸ cell(columnName, gridRow): GridCell

Returns a grid cell at the specified position.

Parameters

Name	Type
`columnName`	`string`
`gridRow`	`number`

Returns

GridCell

Defined in

src/grid.ts:860

close

▸ close(): void

Closes and detaches the viewer.

Returns

void

Inherited from

Viewer.close

Defined in

src/viewer.ts:138

col

▸ col(name): null | GridColumn

Returns a column with the specified name.

Parameters

Name	Type
`name`	`string`

Returns

null | GridColumn

Defined in

src/grid.ts:855

copyViewersLook

▸ copyViewersLook(other): void

Parameters

Name	Type
`other`	`Viewer`<`any`>

Returns

void

Inherited from

Viewer.copyViewersLook

Defined in

src/viewer.ts:324

detach

▸ detach(): void

Gets called when a widget is detached and will no longer be used. Typically used for unsubscribing from events. Be sure to call super.detach() if this method is overridden.

Returns

void

Inherited from

Viewer.detach

Defined in

src/widgets.ts:264

getDartProperties

▸ getDartProperties(): any[]

Returns

any[]

Inherited from

Viewer.getDartProperties

Defined in

src/widgets.ts:246

getInfo

▸ getInfo(): Object

Returns

Object

Inherited from

Viewer.getInfo

Defined in

src/viewer.ts:129

getOptions

▸ getOptions(includeDefaults?): Object

Gets the serialized viewer options. [includeDefaults] flag specifies whether the properties with the default values should be returned. Not including default properties makes it more clean and efficient for serialization purposes.

Parameters

Name	Type	Default value
`includeDefaults`	`boolean`	`false`

Returns

Object

Name	Type
`id`	`string`
`look`	{ `[key: string]`: `any`; }
`type`	`string`

Inherited from

Viewer.getOptions

Defined in

src/viewer.ts:125

getProperties

▸ getProperties(): Property[]

Returns

Property[]

Inherited from

Viewer.getProperties

Defined in

src/viewer.ts:133

getRowOrder

▸ getRowOrder(): Int32Array

Returns the order of rows in the table.

Returns

Int32Array

Defined in

src/grid.ts:930

getVisibleCells

▸ getVisibleCells(column?): Iterable<GridCell>

Returns currently visible cells

Parameters

Name	Type	Default value
`column`	`null` \| `GridColumn`	`null`

Returns

Iterable<GridCell>

Defined in

src/grid.ts:1037

gridRowToTable

▸ gridRowToTable(gridRow): number

Converts grid row index to table index. See also tableRowToGrid

Parameters

Name	Type
`gridRow`	`number`

Returns

number

Defined in

src/grid.ts:978

hitTest

▸ hitTest(x, y): null | GridCell

Returns a grid cell at the specified position, or null if there is none. Sample: https://public.datagrok.ai/js/samples/grid/hit-test

Parameters

Name	Type
`x`	`number`
`y`	`number`

Returns

null | GridCell

Defined in

src/grid.ts:907

initDartObject

▸ initDartObject(dart): void

Parameters

Name	Type
`dart`	`any`

Returns

void

Inherited from

Viewer.initDartObject

Defined in

src/viewer.ts:84

invalidate

▸ invalidate(): void

Causes the grid to repaint. Sample: https://public.datagrok.ai/js/samples/grid/advanced/invalidate

Returns

void

Defined in

src/grid.ts:965

onCellPrepare

▸ onCellPrepare(callback): StreamSubscription

Sample: https://public.datagrok.ai/js/samples/grid/custom-cell-prepare

Parameters

Name	Type
`callback`	(`cell`: `GridCell`) => `any`

Returns

StreamSubscription

Defined in

src/grid.ts:890

onCellTooltip

▸ onCellTooltip(callback): StreamSubscription

Sample: https://public.datagrok.ai/js/samples/grid/custom-cell-tooltip

Parameters

Name	Type
`callback`	(`cell`: `GridCell`, `x`: `number`, `y`: `number`) => `any`

Returns

StreamSubscription

Defined in

src/grid.ts:899

onEvent

▸ onEvent(eventId?): Observable<any>

Observes platform events with the specified eventId.

Parameters

Name	Type	Default value
`eventId`	`null` \| `string`	`null`

Returns

Observable<any>

Inherited from

Viewer.onEvent

Defined in

src/viewer.ts:289

onFrameAttached

▸ onFrameAttached(dataFrame): void

Parameters

Name	Type
`dataFrame`	`DataFrame`

Returns

void

Inherited from

Viewer.onFrameAttached

Defined in

src/widgets.ts:252

onPropertyChanged

▸ onPropertyChanged(property): void

Gets called when viewer's property is changed.

Parameters

Name	Type	Description
`property`	`null` \| `Property`	or null, if multiple properties were changed.

Returns

void

Inherited from

Viewer.onPropertyChanged

Defined in

src/widgets.ts:244

removeFromView

▸ removeFromView(): any

Returns

any

Inherited from

Viewer.removeFromView

Defined in

src/viewer.ts:328

resetRowHeight

▸ resetRowHeight(): void

Resets rows height

Returns

void

Defined in

src/grid.ts:991

runPostponedComputations

▸ runPostponedComputations(): void

Forces the grid to execute calculations that were postponed before the next rendering (such as recalculating layout). Call it in case the client code changes column widths and needs to access the new recalculated layout.

Returns

void

Defined in

src/grid.ts:1000

scrollToCell

▸ scrollToCell(column, row): void

Returns a grid cell at the specified position. Sample: https://public.datagrok.ai/js/samples/grid/scroll-to-cell

Parameters

Name	Type
`column`	`string` \| `Column`<`any`>
`row`	`number`

Returns

void

Defined in

src/grid.ts:951

scrollToPixels

▸ scrollToPixels(x, y): void

Scrolls the grid to the specified position. Sample: https://public.datagrok.ai/js/samples/grid/scroll-to-pixels

Parameters

Name	Type
`x`	`number`
`y`	`number`

Returns

void

Defined in

src/grid.ts:958

setOptions

▸ setOptions(map): void

Sets viewer options. See also getOptions Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/scatter-plot

Parameters

Name	Type
`map`	`Object`
`map.type?`	`string`

Returns

void

Inherited from

Viewer.setOptions

Defined in

src/viewer.ts:113

setRowOrder

▸ setRowOrder(indexes): Grid

Sets the order or rows in the table. Sample: https://public.datagrok.ai/js/samples/grid/order-rows Also,

See

sortIndexes

Parameters

Name	Type
`indexes`	`number`[]

Returns

Grid

Defined in

src/grid.ts:937

sort

▸ sort(columns, orders?): Grid

Sorts rows by the specified [columnIds]. Specify sort directions via [asc] array (true = ascending, false = descending) If [asc] is not specified, sorts in ascending order.