Grid

Defined in: js-api/src/grid.ts:933

High-performance, flexible spreadsheet control

Extends

Viewer<IGridSettings>

Constructors

Constructor

new Grid(dart): Grid

Defined in: js-api/src/grid.ts:935

Parameters

Parameter	Type
`dart`	`any`

Returns

Grid

Overrides

Viewer.constructor

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
`_functions`	`protected`	`Func`[]	`[]`	-	`Viewer`.`_functions`	js-api/src/widgets/base.ts:214
`_properties`	`protected`	`Property`[]	`[]`	-	`Viewer`.`_properties`	js-api/src/widgets/base.ts:213
`_root`	`protected`	`HTMLElement`	`undefined`	-	`Viewer`.`_root`	js-api/src/u2core/component.ts:445
`_u2`	`readonly`	`ComponentState`	`undefined`	-	`Viewer`.`_u2`	js-api/src/u2core/component.ts:82
`componentMeta?`	`public`	`ComponentMetaBase`	`undefined`	The registry metadata of the tag that built this component, stamped by the spec renderer — the single source the introspection surface below is generated from.	`Viewer`.`componentMeta`	js-api/src/u2core/component.ts:77
`dart`	`public`	`any`	`undefined`	-	`Viewer`.`dart`	js-api/src/widgets/base.ts:217
`factory`	`public`	`Func` \| `null`	`null`	Constructor function. No parameters, returns [Widget].	`Viewer`.`factory`	js-api/src/widgets/base.ts:211
`isDetached`	`public`	`boolean`	`false`	-	`Viewer`.`isDetached`	js-api/src/widgets/base.ts:218
`props`	`public`	`IGridSettings` & `ObjectPropertyBag`	`undefined`	-	`Viewer`.`props`	js-api/src/widgets/base.ts:215
`specProps?`	`public`	`Record`<`string`, `unknown`>	`undefined`	The props the registry's `create` was handed, stamped alongside componentMeta: the last resort of the property read below, for a component that keeps a prop under another name or not at all (a `create` wrapping a bare element). Construction-time values — a live one always wins.	`Viewer`.`specProps`	js-api/src/u2core/component.ts:81
`subs`	`public`	`Subscription`[]	`undefined`	-	`Viewer`.`subs`	js-api/src/widgets/base.ts:216
`tags`	`public`	`any`	`undefined`	-	`Viewer`.`tags`	js-api/src/viewer.ts:90
`temp`	`public`	`any`	`undefined`	Contains auxiliary information	`Viewer`.`temp`	js-api/src/widgets/base.ts:208
`CORE_VIEWER_TYPES`	`static`	`string`[]	`undefined`	-	`Viewer`.`CORE_VIEWER_TYPES`	js-api/src/viewer.ts:455

Accessors

aiDescription

Get Signature

get aiDescription(): string | null

Defined in: js-api/src/viewer.ts:117

AI briefing of the underlying Dart viewer.

Returns

string | null

Set Signature

set aiDescription(x): void

Defined in: js-api/src/viewer.ts:122

A short AI-facing briefing, seeded from the registry's usage or description.

Parameters

Parameter	Type
`x`	`string` \| `null`

Returns

void

Inherited from

Viewer.aiDescription

ambientAdoption

Get Signature

get protected ambientAdoption(): boolean

Defined in: js-api/src/widgets/base.ts:272

A widget wrapper minted inside somebody's effect scope must not be auto-disposed with it.

Returns

boolean

Inherited from

Viewer.ambientAdoption

canvas

Get Signature

get canvas(): HTMLCanvasElement

Defined in: js-api/src/grid.ts:988

Returns

HTMLCanvasElement

children

Get Signature

get children(): Widget<any>[]

Defined in: js-api/src/widgets/base.ts:304

Parent widget up the DOM tree, or null.

Returns

Widget<any>[]

Inherited from

Viewer.children

colHeaderBox

Get Signature

get colHeaderBox(): Rect

Defined in: js-api/src/grid.ts:1110

Column labels box

Returns

Rect

colHeaderHeight

Get Signature

get colHeaderHeight(): number

Defined in: js-api/src/grid.ts:1102

Column labels height

Returns

number

columns

Get Signature

get columns(): GridColumnList

Defined in: js-api/src/grid.ts:956

Grid columns.

Returns

GridColumnList

dataFrame

Get Signature

get dataFrame(): DataFrame

Defined in: js-api/src/viewer.ts:292

Returns

DataFrame

Set Signature

set dataFrame(t): void

Defined in: js-api/src/viewer.ts:293

Parameters

Parameter	Type
`t`	`DataFrame`

Returns

void

Inherited from

Viewer.dataFrame

descriptor

Get Signature

get descriptor(): WidgetDescriptor

Defined in: js-api/src/viewer.ts:108

Descriptor of this widget.

Returns

WidgetDescriptor

Inherited from

Viewer.descriptor

filter

Get Signature

get filter(): BitSet

Defined in: js-api/src/viewer.ts:101

combined filter of the viewer

Returns

BitSet

Set Signature

set filter(f): void

Defined in: js-api/src/viewer.ts:104

Parameters

Parameter	Type
`f`	`BitSet`

Returns

void

Inherited from

Viewer.filter

helpUrl

Get Signature

get helpUrl(): string

Defined in: js-api/src/viewer.ts:296

Help URL

Returns

string

Set Signature

set helpUrl(s): void

Defined in: js-api/src/viewer.ts:297

Parameters

Parameter	Type
`s`	`string`

Returns

void

Inherited from

Viewer.helpUrl

horzScroll

Get Signature

get horzScroll(): RangeSlider

Defined in: js-api/src/grid.ts:1097

Horizontal scroll bar

Returns

RangeSlider

name

Get Signature

get name(): string | undefined

Defined in: js-api/src/u2core/component.ts:469

A named control carries its name in the DOM: data-u2-name is the stable automation id selectors, tutorials and agents address the control by — the same attribute the spec renderer stamps on named nodes, so hand-built and spec-built UI share one selector vocabulary. Derived names (an input's label fallback) never stamp — see Component.deriveName.

Returns

string | undefined

Set Signature

set name(x): void

Defined in: js-api/src/u2core/component.ts:473

Unique within a spec: the anchor for selection, patches and automation. An accessor pair (not a field), so a platform descendant's own name accessors override it legally (TS2611).

Parameters

Parameter	Type
`x`	`string` \| `undefined`

Returns

void

Inherited from

Viewer.name

onAfterDrawContent

Get Signature

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

Defined in: js-api/src/grid.ts:1148

Returns

Observable<EventData<any>>

onAfterDrawOverlay

Get Signature

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

Defined in: js-api/src/grid.ts:1146

Fires after rendering of the overlay canvas (interactive layer).

Returns

Observable<EventData<any>>

Overrides

Viewer.onAfterDrawOverlay

onAfterDrawScene

Get Signature

get onAfterDrawScene(): Observable<EventData<any>>

Defined in: js-api/src/viewer.ts:146

Fires after rendering of the main canvas.

Returns

Observable<EventData<any>>

Inherited from

Viewer.onAfterDrawScene

onAfterLayout

Get Signature

get onAfterLayout(): Observable<EventData<any>>

Defined in: js-api/src/viewer.ts:142

Fires after the viewer completes a layout pass.

Returns

Observable<EventData<any>>

Inherited from

Viewer.onAfterLayout

onBeforeDrawContent

Get Signature

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

Defined in: js-api/src/grid.ts:1147

Returns

Observable<EventData<any>>

onBeforeDrawOverlay

Get Signature

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

Defined in: js-api/src/grid.ts:1145

Fires before rendering of the overlay canvas (interactive layer).

Returns

Observable<EventData<any>>

Overrides

Viewer.onBeforeDrawOverlay

onBeforeDrawScene

Get Signature

get onBeforeDrawScene(): Observable<EventData<any>>

Defined in: js-api/src/viewer.ts:144

Fires before rendering of the main canvas.

Returns

Observable<EventData<any>>

Inherited from

Viewer.onBeforeDrawScene

onCellClick

Get Signature

get onCellClick(): Observable<GridCell<any>>

Defined in: js-api/src/grid.ts:1139

Returns

Observable<GridCell<any>>

onCellDoubleClick

Get Signature

get onCellDoubleClick(): Observable<GridCell<any>>

Defined in: js-api/src/grid.ts:1140

Returns

Observable<GridCell<any>>

onCellKeyDown

Get Signature

get onCellKeyDown(): Observable<GridCell<any>>

Defined in: js-api/src/grid.ts:1142

Returns

Observable<GridCell<any>>

onCellMouseDown

Get Signature

get onCellMouseDown(): Observable<GridCell<any>>

Defined in: js-api/src/grid.ts:1141

Returns

Observable<GridCell<any>>

onCellMouseEnter

Get Signature

get onCellMouseEnter(): Observable<GridCell<any>>

Defined in: js-api/src/grid.ts:1136

Returns

Observable<GridCell<any>>

onCellMouseLeave

Get Signature

get onCellMouseLeave(): Observable<GridCell<any>>

Defined in: js-api/src/grid.ts:1137

Returns

Observable<GridCell<any>>

onCellRender

Get Signature

get onCellRender(): Observable<GridCellRenderArgs>

Defined in: js-api/src/grid.ts:976

Occurs after the grid cell has been rendered. Do args.preventDefault() to prevent standard rendering. Sample: https://public.datagrok.ai/js/samples/grid/custom-cell-rendering-indexes See also onCellRendered.

Returns

Observable<GridCellRenderArgs>

onCellRendered

Get Signature

get onCellRendered(): Observable<GridCellRenderArgs>

Defined in: js-api/src/grid.ts:983

Occurs after the grid cell has been rendered. See also onCellRender.

Returns

Observable<GridCellRenderArgs>

onCellValueEdited

Get Signature

get onCellValueEdited(): Observable<GridCell<any>>

Defined in: js-api/src/grid.ts:1134

Returns

Observable<GridCell<any>>

onColumnResized

Get Signature

get onColumnResized(): Observable<any>

Defined in: js-api/src/grid.ts:1123

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

Returns

Observable<any>

onContextMenu

Get Signature

get onContextMenu(): Observable<Menu>

Defined in: js-api/src/viewer.ts:400

Returns

Observable<Menu>

Inherited from

Viewer.onContextMenu

onCurrentCellChanged

Get Signature

get onCurrentCellChanged(): Observable<GridCell<any>>

Defined in: js-api/src/grid.ts:1135

Returns

Observable<GridCell<any>>

onDartPropertyChanged

Get Signature

get onDartPropertyChanged(): Observable<null>

Defined in: js-api/src/viewer.ts:426

Returns

Observable<null>

Inherited from

Viewer.onDartPropertyChanged

onDataEvent

Get Signature

get onDataEvent(): Observable<ViewerEvent>

Defined in: js-api/src/viewer.ts:130

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onDataEvent

onDataFrameChanged

Get Signature

get onDataFrameChanged(): Observable<any>

Defined in: js-api/src/viewer.ts:138

Fires when the viewer's underlying DataFrame is replaced (table attached).

Returns

Observable<any>

Inherited from

Viewer.onDataFrameChanged

onDataRowClicked

Get Signature

get onDataRowClicked(): Observable<ViewerEvent>

Defined in: js-api/src/viewer.ts:134

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onDataRowClicked

onDataSelected

Get Signature

get onDataSelected(): Observable<ViewerEvent>

Defined in: js-api/src/viewer.ts:132

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onDataSelected

onDetached

Get Signature

get onDetached(): Observable<any>

Defined in: js-api/src/viewer.ts:441

Occurs when viewer is detached.

Returns

Observable<any>

Inherited from

Viewer.onDetached

onGridCellLinkClicked

Get Signature

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

Defined in: js-api/src/grid.ts:1150

Returns

Observable<EventData<GridCellArgs>>

onPinnedRowsChanged

Get Signature

get onPinnedRowsChanged(): Observable<any>

Defined in: js-api/src/grid.ts:1132

Returns

Observable<any>

onPropertyValueChanged

Get Signature

get onPropertyValueChanged(): Observable<EventData<Property>>

Defined in: js-api/src/viewer.ts:135

Returns

Observable<EventData<Property>>

Inherited from

Viewer.onPropertyValueChanged

onResized

Get Signature

get onResized(): Observable<null>

Defined in: js-api/src/viewer.ts:140

Fires when the viewer is resized.

Returns

Observable<null>

Inherited from

Viewer.onResized

onRowEnter

Get Signature

get onRowEnter(): Observable<GridCell<any>>

Defined in: js-api/src/grid.ts:1143

Returns

Observable<GridCell<any>>

onRowsResized

Get Signature

get onRowsResized(): Observable<any>

Defined in: js-api/src/grid.ts:1128

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

Returns

Observable<any>

onRowsSorted

Get Signature

get onRowsSorted(): Observable<any>

Defined in: js-api/src/grid.ts:1131

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

Returns

Observable<any>

onTooltipCreated

Get Signature

get onTooltipCreated(): Observable<ViewerEvent>

Defined in: js-api/src/viewer.ts:131

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onTooltipCreated

onTooltipCreating

Get Signature

get onTooltipCreating(): Observable<GridTooltipArgs>

Defined in: js-api/src/grid.ts:1149

Returns

Observable<GridTooltipArgs>

onViewerRendered

Get Signature

get onViewerRendered(): Observable<EventData<any>>

Defined in: js-api/src/viewer.ts:152

Fires after the viewer is rendered.

Returns

Observable<EventData<any>>

Inherited from

Viewer.onViewerRendered

overlay

Get Signature

get overlay(): HTMLCanvasElement

Defined in: js-api/src/grid.ts:993

Returns

HTMLCanvasElement

parent

Get Signature

get parent(): Widget<any> | null

Defined in: js-api/src/widgets/base.ts:301

Parent widget up the DOM tree, or null.

Returns

Widget<any> | null

Inherited from

Viewer.parent

pinnedRows

Get Signature

get pinnedRows(): Iterable<number>

Defined in: js-api/src/grid.ts:1060

Pinned rows.

Returns

Iterable<number>

propertyTarget

Get Signature

get propertyTarget(): unknown

Defined in: js-api/src/viewer.ts:214

A viewer's property lives on its look, which the props bag is over. Read per call: a viewer's look is settable.

Returns

unknown

Inherited from

Viewer.propertyTarget

propertyTier

Get Signature

get propertyTier(): boolean

Defined in: js-api/src/widgets/base.ts:276

Every property getProperties declares is a bind step, read and written on propertyTarget.

Returns

boolean

Inherited from

Viewer.propertyTier

root

Get Signature

get root(): HTMLElement

Defined in: js-api/src/viewer.ts:261

Visual root.

Returns

HTMLElement

Inherited from

Viewer.root

scope

Get Signature

get scope(): Scope

Defined in: js-api/src/u2core/component.ts:53

Minted on first use; assigned before _scopeMinted fires, so the hook's own this.scope.own(...) reads the stored scope instead of re-entering the mint.

Returns

Scope

Inherited from

Viewer.scope

sortByColumns

Get Signature

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

Defined in: js-api/src/grid.ts:998

List of columns the grid is sorted by.

Returns

Column<any, any>[]

sortTypes

Get Signature

get sortTypes(): boolean[]

Defined in: js-api/src/grid.ts:1001

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

Returns

boolean[]

table

Get Signature

get table(): DataFrame

Defined in: js-api/src/viewer.ts:277

Returns

DataFrame

Inherited from

Viewer.table

tableView

Get Signature

get tableView(): TableView | null

Defined in: js-api/src/viewer.ts:287

Returns a view this viewer is associated with, or null

Returns

TableView | null

Inherited from

Viewer.tableView

type

Get Signature

get type(): string

Defined in: js-api/src/viewer.ts:273

Returns viewer type (see VIEWER constants)

Returns

string

Inherited from

Viewer.type

vertScroll

Get Signature

get vertScroll(): RangeSlider

Defined in: js-api/src/grid.ts:1086

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

Returns

RangeSlider

view

Get Signature

get view(): View | null

Defined in: js-api/src/viewer.ts:282

Returns a view this viewer is associated with, or null

Returns

View | null

Inherited from

Viewer.view

Methods

_notifyPropertyChange()

protected _notifyPropertyChange(p): void

Defined in: js-api/src/widgets/base.ts:351

Notifies the property tier. Called from both the addProperty setter (overrides that skip super would otherwise lose props.x = writes) and onPropertyChanged (direct calls); the double notify collapses into one microtask refresh.

Parameters

Parameter	Type
`p`	`Property` \| `null`

Returns

void

Inherited from

Viewer._notifyPropertyChange

_ownPropertyChanges()

protected _ownPropertyChanges(): ObservableLike<PropertyChange>

Defined in: js-api/src/widgets/base.ts:356

Returns

ObservableLike<PropertyChange>

Inherited from

Viewer._ownPropertyChanges

_scopeMinted()

protected _scopeMinted(_scope): void

Defined in: js-api/src/widgets/base.ts:320

First-mint hook: a platform descendant wires its lifecycle here. Never fired for a scope provided to init — that path runs inside the constructor chain.

Parameters

Parameter	Type
`_scope`	`Scope`

Returns

void

Inherited from

Viewer._scopeMinted

_wireDartLifecycle()

protected _wireDartLifecycle(): void

Defined in: js-api/src/widgets/base.ts:336

Dart-owned lifecycle: the platform kill disposes the scope, and disposing the scope kills the widget through the kill-walk.

Returns

void

Inherited from

Viewer._wireDartLifecycle

_wireJsLifecycle()

protected _wireJsLifecycle(): void

Defined in: js-api/src/widgets/base.ts:327

JS-owned lifecycle: disposing the scope detaches the widget, and vice versa.

Returns

void

Inherited from

Viewer._wireJsLifecycle

_wireLifecycle()

protected _wireLifecycle(): void

Defined in: js-api/src/viewer.ts:226

Returns

void

Inherited from

Viewer._wireLifecycle

apply()

apply(properties): Widget

Defined in: js-api/src/widgets/base.ts:261

Parameters

Parameter	Type	Description
`properties`	`object`	-

Returns

Widget

Inherited from

Viewer.apply

autoSize()

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

Defined in: js-api/src/grid.ts:1158

Resizes the grid to fit the content

Parameters

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

Returns

void

bindProps()

bindProps(): BindProp[]

Defined in: js-api/src/viewer.ts:246

The signal-backed subset of the meta props — what a binding picker offers on a named node — plus, under propertyTier, every declared property. Allocates no signal.

Returns

BindProp[]

Inherited from

Viewer.bindProps

bindStep()

bindStep(name): BindSource | Signal<unknown> | null

Defined in: js-api/src/viewer.ts:233

One binding step (DD5): a meta-declared prop's same-named Signal member — a named node is a bind source, generated off componentMeta the way getProperties is — then, under propertyTier, a cached signal over the declared property. '' answers the default binding: the component's own value signal, where one exists.

Parameters

Parameter	Type
`name`	`string`

Returns

BindSource | Signal<unknown> | null

Inherited from

Viewer.bindStep

cell()

cell(columnName, gridRow): GridCell

Defined in: js-api/src/grid.ts:968

Returns a grid cell at the specified position.

Parameters

Parameter	Type
`columnName`	`string`
`gridRow`	`number`

Returns

GridCell

close()

close(): void

Defined in: js-api/src/viewer.ts:255

Closes and detaches the viewer.

Returns

void

Inherited from

Viewer.close

col()

col(name): GridColumn<any> | null

Defined in: js-api/src/grid.ts:963

Returns a column with the specified name.

Parameters

Parameter	Type	Description
`name`	`string`	-

Returns

GridColumn<any> | null

copyViewersLook()

copyViewersLook(other): void

Defined in: js-api/src/viewer.ts:443

Parameters

Parameter	Type
`other`	`Viewer`

Returns

void

Inherited from

Viewer.copyViewersLook

deriveName()

protected deriveName(x): void

Defined in: js-api/src/u2core/component.ts:72

Sets the introspection/form key without claiming an automation id — the label-fallback path: a caption is not a stable identity, so it never reaches data-u2-name.

Parameters

Parameter	Type
`x`	`string` \| `undefined`

Returns

void

Inherited from

Viewer.deriveName

detach()

detach(): void

Defined in: js-api/src/widgets/base.ts:308

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

dispose()

dispose(): void

Defined in: js-api/src/u2core/component.ts:147

On a never-engaged wrapper the getter mints here and _scopeMinted wires the lifecycle (own(kill) + the platform cleanup for Dart-owned), so dispose still kills it; re-entry from the kill cleanup is a no-op via the scope's disposed flag.

Returns

void

Inherited from

Viewer.dispose

effect()

effect(fn): this

Defined in: js-api/src/u2core/component.ts:134

Parameters

Parameter	Type
`fn`	() => `void`

Returns

this

Inherited from

Viewer.effect

fireEvent()

protected fireEvent(eventId, args?): void

Defined in: js-api/src/u2core/component.ts:435

Parameters

Parameter	Type
`eventId`	`string`
`args?`	`unknown`

Returns

void

Inherited from

Viewer.fireEvent

getDartProperties()

getDartProperties(): any[]

Defined in: js-api/src/widgets/base.ts:289

Returns

any[]

Inherited from

Viewer.getDartProperties

getFunctions()

getFunctions(): Func[]

Defined in: js-api/src/viewer.ts:114

Functions applicable to the underlying Dart viewer.

Returns

Func[]

Inherited from

Viewer.getFunctions

getInfo()

getInfo(): object

Defined in: js-api/src/viewer.ts:204

Returns

object

Inherited from

Viewer.getInfo

getOptions()

getOptions(includeDefaults?): object

Defined in: js-api/src/viewer.ts:200

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

Parameter	Type	Default value
`includeDefaults`	`boolean`	`false`

Returns

object

Name	Type	Defined in
`id`	`string`	js-api/src/viewer.ts:200
`look`	`object`	js-api/src/viewer.ts:200
`type`	`string`	js-api/src/viewer.ts:200

Inherited from

Viewer.getOptions

getProperties()

getProperties(): Property[]

Defined in: js-api/src/viewer.ts:208

Returns all properties of this widget: the meta-generated ones plus addProperty's.

Returns

Property[]

Inherited from

Viewer.getProperties

getRowOrder()

getRowOrder(): Int32Array

Defined in: js-api/src/grid.ts:1046

Returns the order of rows in the table.

Returns

Int32Array

getVisibleCells()

getVisibleCells(column?): Iterable<GridCell<any>>

Defined in: js-api/src/grid.ts:1153

Returns currently visible cells

Parameters

Parameter	Type	Default value
`column`	`GridColumn`<`any`> \| `null`	`null`

Returns

Iterable<GridCell<any>>

getWidgetStatus()

getWidgetStatus(): IWidgetStatus

Defined in: js-api/src/viewer.ts:111

Returns the widget's runtime structure for automated testing and introspection.

Returns

IWidgetStatus

Inherited from

Viewer.getWidgetStatus

gridRowToTable()

gridRowToTable(gridRow): number

Defined in: js-api/src/grid.ts:1094

Converts grid row index to table index. See also tableRowToGrid

Parameters

Parameter	Type
`gridRow`	`number`

Returns

number

hitTest()

hitTest(x, y): GridCell<any> | null

Defined in: js-api/src/grid.ts:1023

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

Parameter	Type
`x`	`number`
`y`	`number`

Returns

GridCell<any> | null

initDartObject()

initDartObject(dart): void

Defined in: js-api/src/viewer.ts:154

Parameters

Parameter	Type
`dart`	`any`

Returns

void

Inherited from

Viewer.initDartObject

invalidate()

invalidate(): void

Defined in: js-api/src/grid.ts:1081

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

Returns

void

link()

link(name, source, twoWay): void

Defined in: js-api/src/u2core/component.ts:268

Keeps this component's name step and source equal, echo-suppressed by value; the reverse direction only where twoWay. A component that took source as its own signal needs no link and gets none; a read-only step cannot follow anything and gets none either.

Parameters

Parameter	Type
`name`	`string`
`source`	`Signal`<`unknown`>
`twoWay`	`boolean`

Returns

void

Inherited from

Viewer.link

onCellPrepare()

onCellPrepare(callback): StreamSubscription

Defined in: js-api/src/grid.ts:1006

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

Parameters

Parameter	Type
`callback`	(`cell`) => `any`

Returns

StreamSubscription

onCellTooltip()

onCellTooltip(callback): StreamSubscription

Defined in: js-api/src/grid.ts:1015

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

Parameters

Parameter	Type
`callback`	(`cell`, `x`, `y`) => `any`

Returns

StreamSubscription

onEvent()

onEvent(eventId?): Observable<any>

Defined in: js-api/src/viewer.ts:405

Observes platform events with the specified eventId.

Parameters

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

Returns

Observable<any>

Inherited from

Viewer.onEvent

onFrameAttached()

onFrameAttached(dataFrame): void

Defined in: js-api/src/widgets/base.ts:295

Parameters

Parameter	Type
`dataFrame`	`DataFrame`

Returns

void

Inherited from

Viewer.onFrameAttached

onPropertyChanged()

onPropertyChanged(property): void

Defined in: js-api/src/widgets/base.ts:287

Gets called when viewer's property is changed.

Parameters

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

Returns

void

Inherited from

Viewer.onPropertyChanged

own()

own(dispose): this

Defined in: js-api/src/u2core/component.ts:139

Parameters

Parameter	Type
`dispose`	() => `void`

Returns

this

Inherited from

Viewer.own

propertyChanges()

protected propertyChanges(): ObservableLike<PropertyChange>

Defined in: js-api/src/viewer.ts:216

What refreshes the property tier's cached signals from outside: null where nothing announces a change (one-way).

Returns

ObservableLike<PropertyChange>

Inherited from

Viewer.propertyChanges

registerFunction()

protected registerFunction(f): void

Defined in: js-api/src/u2core/component.ts:431

Parameters

Parameter	Type
`f`	`FuncLike`

Returns

void

Inherited from

Viewer.registerFunction

removeFromView()

removeFromView(): any

Defined in: js-api/src/viewer.ts:447

Returns

any

Inherited from

Viewer.removeFromView

render()

render(g, bounds): void

Defined in: js-api/src/grid.ts:1169

Renders the content of this grid to the specified canvas and bounds.

Parameters

Parameter	Type
`g`	`CanvasRenderingContext2D`
`bounds`	`Rect`

Returns

void

resetRowHeight()

resetRowHeight(): void

Defined in: js-api/src/grid.ts:1107

Resets rows height

Returns

void

runInScope()

runInScope<T>(fn): T

Defined in: js-api/src/u2core/component.ts:130

Type Parameters

Type Parameter
`T`

Parameters

Parameter	Type
`fn`	() => `T`

Returns

T

Inherited from

Viewer.runInScope

runPostponedComputations()

runPostponedComputations(): void

Defined in: js-api/src/grid.ts:1116

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

scrollToCell()

scrollToCell(column, row): void

Defined in: js-api/src/grid.ts:1067

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

Parameters

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

Returns

void

scrollToPixels()

scrollToPixels(x, y): void

Defined in: js-api/src/grid.ts:1074

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

Parameters

Parameter	Type
`x`	`number`
`y`	`number`

Returns

void

setColumnsWidthType()

setColumnsWidthType(type, columns?): void

Defined in: js-api/src/grid.ts:1164

Applies a column-width policy (Minimal / Compact / Optimal / Maximal) to the given columns, or to all columns when columns is omitted. Same as Grid's right-click menu → "Column Sizing".

Parameters

Parameter	Type
`type`	`ColumnWidthType`
`columns?`	`GridColumn`<`any`>[]

Returns

void

setOptions()

setOptions(map): void

Defined in: js-api/src/viewer.ts:188

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

Parameters

Parameter	Type	Description
`map`	{[`key`: `string`]: `any`; `type?`: `string`; }	-
`map.type?`	`string`	-

Returns

void

Inherited from

Viewer.setOptions

setRowOrder()

setRowOrder(indexes): Grid

Defined in: js-api/src/grid.ts:1053

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

Parameters

Parameter	Type
`indexes`	`number`[]

Returns

Grid

See

sortIndexes

sort()

sort(columns, orders?): Grid

Defined in: js-api/src/grid.ts:1030

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.

Parameters

Parameter	Type	Default value
`columns`	`string`[] \| `Column`<`any`, `any`>[]	`undefined`
`orders`	`boolean`[] \| `null`	`null`

Returns

Grid

sortIndexes()

sortIndexes(indexComparer): Grid

Defined in: js-api/src/grid.ts:1038

Sorts the rows, using the specified comparer that accepts indexes. Sample: https://public.datagrok.ai/js/samples/grid/order-rows-by-comparer Also,

Parameters

Parameter	Type
`indexComparer`	(`a`, `b`) => `number`

Returns

Grid

See

setRowOrder

sourceRowsChanged()

sourceRowsChanged(): void

Defined in: js-api/src/widgets/base.ts:293

Returns

void

Inherited from

Viewer.sourceRowsChanged

sub()

sub(subscription): void

Defined in: js-api/src/widgets/base.ts:254

Registers a subscription to an external event.

Parameters

Parameter	Type	Description
`subscription`	`Subscription`	-

Returns

void

Inherited from

Viewer.sub

tableRowToGrid()

tableRowToGrid(tableRow): number

Defined in: js-api/src/grid.ts:1091

Converts table row index to grid index. See also gridRowToTable

Parameters

Parameter	Type
`tableRow`	`number`

Returns

number

toCompactLook()

toCompactLook(): void

Defined in: js-api/src/viewer.ts:422

Returns

void

Inherited from

Viewer.toCompactLook

toDart()

toDart(): any

Defined in: js-api/src/widgets/base.ts:246

Returns

any

Inherited from

Viewer.toDart

barChart()

static barChart(t, options?): Viewer<IBarChartSettings>

Defined in: js-api/src/viewer.ts:307

Parameters

Parameter	Type
`t`	`DataFrame`
`options?`	`Partial`<`IBarChartSettings`>

Returns

Viewer<IBarChartSettings>

Inherited from

Viewer.barChart

boxPlot()

static boxPlot(t, options?): BoxPlot

Defined in: js-api/src/viewer.ts:323

Parameters

Parameter	Type
`t`	`DataFrame`
`options?`	`Partial`<`IBoxPlotSettings`>

Returns

BoxPlot

Inherited from

Viewer.boxPlot

build()

static build(builder): Control

Defined in: js-api/src/u2core/component.ts:529

Builds a control out of plain elements: builder runs with the new control's scope ambient, so signal bindings and nested components inside it are owned by the result. The ambient scope only spans the synchronous part of builder — components constructed after an await inside it are adopted by nobody and must be disposed by hand, or constructed before the first await.

Parameters

Parameter	Type
`builder`	() => `HTMLElement` \| (`string` \| `HTMLElement` \| `Control`)[]

Returns

Control

Inherited from

Viewer.build

calendar()

static calendar(t, options?): CalendarViewer

Defined in: js-api/src/viewer.ts:343

Parameters

Parameter	Type
`t`	`DataFrame`
`options?`	`Partial`<`ICalendarSettings`>

Returns

CalendarViewer

Inherited from

Viewer.calendar

canVisualize()

static canVisualize(viewerType, dataFrame): string | null

Defined in: js-api/src/viewer.ts:451

Parameters

Parameter	Type
`viewerType`	`string`
`dataFrame`	`DataFrame`

Returns

string | null

Inherited from

Viewer.canVisualize

confusionMatrix()

static confusionMatrix(t, options?): ConfusionMatrix

Defined in: js-api/src/viewer.ts:311

Parameters

Parameter	Type
`t`	`DataFrame`
`options?`	`Partial`<`IConfusionMatrixSettings`>

Returns

ConfusionMatrix

Inherited from

Viewer.confusionMatrix

correlationPlot()

static correlationPlot(t, options?): Viewer<ICorrelationPlotSettings>

Defined in: js-api/src/viewer.ts:347

Parameters

Parameter	Type
`t`	`DataFrame`
`options?`	`Partial`<`ICorrelationPlotSettings`>

Returns

Viewer<ICorrelationPlotSettings>

Inherited from

Viewer.correlationPlot

create()

static create(table): Grid

Defined in: js-api/src/grid.ts:940

Creates a new grid.

Parameters

Parameter	Type
`table`	{ `dart`: `any`; }
`table.dart`	`any`

Returns

Grid

densityPlot()

static densityPlot(t, options?): DensityPlotViewer

Defined in: js-api/src/viewer.ts:351

Parameters

Parameter	Type
`t`	`DataFrame`
`options?`	`Partial`<`IDensityPlotSettings`>

Returns

DensityPlotViewer

Inherited from

Viewer.densityPlot

filters()

static filters(t, options?): Viewer<IFiltersSettings>

Defined in: js-api/src/viewer.ts:327

Parameters

Parameter	Type
`t`	`DataFrame`
`options?`	`Partial`<`IFiltersSettings`>

Returns

Viewer<IFiltersSettings>

Inherited from

Viewer.filters

find()

static find(root): Widget<any> | null

Defined in: js-api/src/widgets/base.ts:236

Finds existing widget from its visual root.

Parameters

Parameter	Type
`root`	`Element`

Returns

Widget<any> | null

Inherited from

Viewer.find

forElement()

static forElement(el): Control | undefined

Defined in: js-api/src/u2core/component.ts:489

The nearest control owning el — the DOM → component door for tooling, automation and inspectors (the u2 counterpart of the platform's Widget.find). Best-effort: the last control constructed on (or assigned) a root wins it.

Parameters

Parameter	Type
`el`	`Element` \| `null`

Returns

Control | undefined

Inherited from

Viewer.forElement

form()

static form(t, options?): FormViewer

Defined in: js-api/src/viewer.ts:355

Parameters

Parameter	Type
`t`	`DataFrame`
`options?`	`Partial`<`IFormSettings`>

Returns

FormViewer

Inherited from

Viewer.form

fromProperties()

static fromProperties(items, props): Grid

Defined in: js-api/src/grid.ts:945

Creates a new grid from a list of items (rows) and their properties (columns)

Parameters

Parameter	Type
`items`	`any`[]
`props`	`Property`[]

Returns

Grid

fromRoot()

static fromRoot(root): Widget

Defined in: js-api/src/widgets/base.ts:425

Creates a new widget from the root element.

Parameters

Parameter	Type
`root`	`HTMLElement`

Returns

Widget

Inherited from

Viewer.fromRoot

fromType()

static fromType(viewerType, table, options?): Viewer

Defined in: js-api/src/viewer.ts:170

Creates a new viewer of the specified type.

Parameters

Parameter	Type	Default value	Description
`viewerType`	`string`	`undefined`	-
`table`	`DataFrame`	`undefined`	-
`options`	`object` \| `null`	`null`	-

Returns

Viewer

Inherited from

Viewer.fromType

getAll()

static getAll(): Widget<any>[]

Defined in: js-api/src/widgets/base.ts:231

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

Viewer.getAll

getViewerTypes()

static getViewerTypes(options?): string[]

Defined in: js-api/src/viewer.ts:177

Gets all available viewer types Core means the viewer is already loaded and all methods and properties are available synchronously.

Parameters

Parameter	Type
`options?`	{ `core?`: `boolean`; }
`options.core?`	`boolean`

Returns

string[]

Inherited from

Viewer.getViewerTypes

grid()

static grid(t, options?): Grid

Defined in: js-api/src/viewer.ts:299

Parameters

Parameter	Type
`t`	`DataFrame`
`options?`	`Partial`<`IGridSettings`>

Returns

Grid

Inherited from

Viewer.grid

heatMap()

static heatMap(t, options?): Grid

Defined in: js-api/src/viewer.ts:319

Parameters

Parameter	Type
`t`	`DataFrame`
`options?`	`Partial`<`IGridSettings`>

Returns

Grid

Inherited from

Viewer.heatMap

histogram()

static histogram(t, options?): HistogramViewer

Defined in: js-api/src/viewer.ts:303

Parameters

Parameter	Type
`t`	`DataFrame`
`options?`	`Partial`<`IHistogramSettings`>

Returns

HistogramViewer

Inherited from

Viewer.histogram

init()

static init(self, scope?): void

Defined in: js-api/src/u2core/component.ts:89

Per-instance state, for a constructed component and for an adopted platform object alike.

Parameters

Parameter	Type
`self`	`Component`
`scope?`	`Scope`

Returns

void

Inherited from

Viewer.init

is()

static is(x): x is Control

Defined in: js-api/src/u2core/component.ts:498

Structural probe by methods only — never .scope: the accessor mints.

Parameters

Parameter	Type
`x`	`unknown`

Returns

x is Control

Inherited from

Viewer.is

lineChart()

static lineChart(t, options?): LineChartViewer

Defined in: js-api/src/viewer.ts:335

Parameters

Parameter	Type
`t`	`DataFrame`
`options?`	`Partial`<`ILineChartSettings`>

Returns

LineChartViewer

Inherited from

Viewer.lineChart

markup()

static markup(t, options?): Viewer<IMarkupViewerSettings>

Defined in: js-api/src/viewer.ts:359

Parameters

Parameter	Type
`t`	`DataFrame`
`options?`	`Partial`<`IMarkupViewerSettings`>

Returns

Viewer<IMarkupViewerSettings>

Inherited from

Viewer.markup

matrixPlot()

static matrixPlot(t, options?): MatrixPlot

Defined in: js-api/src/viewer.ts:363

Parameters

Parameter	Type
`t`	`DataFrame`
`options?`	`Partial`<`IMatrixPlotSettings`>

Returns

MatrixPlot

Inherited from

Viewer.matrixPlot

network()

static network(t, options?): NetworkDiagramViewer

Defined in: js-api/src/viewer.ts:339

Parameters

Parameter	Type
`t`	`DataFrame`
`options?`	`Partial`<`INetworkDiagramSettings`>

Returns

NetworkDiagramViewer

Inherited from

Viewer.network

pcPlot()

static pcPlot(t, options?): Viewer<IPcPlotSettings>

Defined in: js-api/src/viewer.ts:367

Parameters

Parameter	Type
`t`	`DataFrame`
`options?`	`Partial`<`IPcPlotSettings`>

Returns

Viewer<IPcPlotSettings>

Inherited from

Viewer.pcPlot

pieChart()

static pieChart(t, options?): Viewer<IPieChartSettings>

Defined in: js-api/src/viewer.ts:371

Parameters

Parameter	Type
`t`	`DataFrame`
`options?`	`Partial`<`IPieChartSettings`>

Returns

Viewer<IPieChartSettings>

Inherited from

Viewer.pieChart

registerCleanup()

static registerCleanup(element, cleanup): void

Defined in: js-api/src/widgets/base.ts:242

Registers a cleanup function to run when [element] is killed — i.e. when its host view or pane closes. Also marks the element so the kill-walk can find it.

Parameters

Parameter	Type
`element`	`Element`
`cleanup`	`Function`

Returns

void

Inherited from

Viewer.registerCleanup

rocCurve()

static rocCurve(t, options?): RocCurve

Defined in: js-api/src/viewer.ts:315

Parameters

Parameter	Type
`t`	`DataFrame`
`options?`	`Partial`<`IRocCurveSettings`>

Returns

RocCurve

Inherited from

Viewer.rocCurve

sameValue()

static sameValue(a, b): boolean

Defined in: js-api/src/u2core/component.ts:111

The equality the property tier and link suppress echoes by: Object.is, arrays element-wise, plain objects key-wise (recursive), everything else by identity.

Parameters

Parameter	Type
`a`	`unknown`
`b`	`unknown`

Returns

boolean

Inherited from

Viewer.sameValue

scatterPlot()

static scatterPlot(t, options?): ScatterPlotViewer

Defined in: js-api/src/viewer.ts:331

Parameters

Parameter	Type
`t`	`DataFrame`
`options?`	`Partial`<`IScatterPlotSettings`>

Returns

ScatterPlotViewer

Inherited from

Viewer.scatterPlot

scatterPlot3d()

static scatterPlot3d(t, options?): Viewer<IScatterPlot3dSettings>

Defined in: js-api/src/viewer.ts:375

Parameters

Parameter	Type
`t`	`DataFrame`
`options?`	`Partial`<`IScatterPlot3dSettings`>

Returns

Viewer<IScatterPlot3dSettings>

Inherited from

Viewer.scatterPlot3d

statistics()

static statistics(t, options?): Viewer<IStatsViewerSettings>

Defined in: js-api/src/viewer.ts:379

Parameters

Parameter	Type
`t`	`DataFrame`
`options?`	`Partial`<`IStatsViewerSettings`>

Returns

Viewer<IStatsViewerSettings>

Inherited from

Viewer.statistics

tile()

static tile(t, options?): TileViewer

Defined in: js-api/src/viewer.ts:383

Parameters

Parameter	Type
`t`	`DataFrame`
`options?`	`Partial`<`ITileViewerSettings`>

Returns

TileViewer

Inherited from

Viewer.tile

treeMap()

static treeMap(t, options?): TreeMap

Defined in: js-api/src/viewer.ts:387

Parameters

Parameter	Type
`t`	`DataFrame`
`options?`	`Partial`<`ITreeMapSettings`>

Returns

TreeMap

Inherited from

Viewer.treeMap

trellisPlot()

static trellisPlot(t, options?): Viewer<ITrellisPlotSettings>

Defined in: js-api/src/viewer.ts:391

Parameters

Parameter	Type
`t`	`DataFrame`
`options?`	`Partial`<`ITrellisPlotSettings`>

Returns

Viewer<ITrellisPlotSettings>

Inherited from

Viewer.trellisPlot

wordCloud()

static wordCloud(t, options?): Viewer

Defined in: js-api/src/viewer.ts:396

Parameters

Parameter	Type
`t`	`DataFrame`
`options?`	`any`

Returns

Viewer

Deprecated

Inherited from

Viewer.wordCloud

Extends​

Constructors​

Constructor​

Parameters​

Returns​

Overrides​

Properties​

Accessors​

aiDescription​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

ambientAdoption​

Get Signature​

Returns​

Inherited from​

canvas​

Get Signature​

Returns​

children​

Get Signature​

Returns​

Inherited from​

colHeaderBox​

Get Signature​

Returns​

colHeaderHeight​

Get Signature​

Returns​

columns​

Get Signature​

Returns​

dataFrame​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

descriptor​

Get Signature​

Returns​

Inherited from​

filter​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

helpUrl​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

horzScroll​

Get Signature​

Returns​

meta​

Get Signature​

Returns​

Inherited from​

name​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

onAfterDrawContent​

Get Signature​

Returns​

onAfterDrawOverlay​

Get Signature​

Returns​

Extends

Constructors

Constructor

Parameters

Returns

Overrides

Properties

Accessors

aiDescription

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

ambientAdoption

Get Signature

Returns

Inherited from

canvas

Get Signature

Returns

children

Get Signature

Returns

Inherited from

colHeaderBox

Get Signature

Returns

colHeaderHeight

Get Signature

Returns

columns

Get Signature

Returns

dataFrame

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

descriptor

Get Signature

Returns

Inherited from

filter

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

helpUrl

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

horzScroll

Get Signature

Returns

meta

Get Signature

Returns

Inherited from

name

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

onAfterDrawContent

Get Signature

Returns

onAfterDrawOverlay

Get Signature

Returns