TableView

Defined in: js-api/src/views/view.ts:415

A View that is associated with a DataFrame and exposes exploratory data analysis functionality. This view gets opened whenever a new table is added to the workspace when a user drag-and-drops a CSV file, or opens a table in any other way.

Extends

View

Constructors

Constructor

new TableView(dart): TableView

Defined in: js-api/src/views/view.ts:417

Parameters

Parameter	Type
`dart`	`any`

Returns

TableView

Overrides

View.constructor

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
`_functions`	`protected`	`Func`[]	`[]`	-	`View`.`_functions`	js-api/src/widgets/base.ts:207
`_name`	`protected`	`string`	`'New View'`	-	`View`.`_name`	js-api/src/views/view.ts:108
`_properties`	`protected`	`Property`[]	`[]`	-	`View`.`_properties`	js-api/src/widgets/base.ts:206
`_root`	`protected`	`HTMLElement`	`undefined`	-	`View`.`_root`	js-api/src/u2core/component.ts:445
`_u2`	`readonly`	`ComponentState`	`undefined`	-	`View`.`_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.	`View`.`componentMeta`	js-api/src/u2core/component.ts:77
`dart`	`public`	`any`	`undefined`	-	`View`.`dart`	js-api/src/views/view.ts:49
`factory`	`public`	`Func` \| `null`	`null`	Constructor function. No parameters, returns [Widget].	`View`.`factory`	js-api/src/widgets/base.ts:204
`isDetached`	`public`	`boolean`	`false`	Whether detach has been called.	`View`.`isDetached`	js-api/src/widgets/base.ts:214
`props`	`public`	`any`	`undefined`	Property bag over this widget's properties; read and write them by name.	`View`.`props`	js-api/src/widgets/base.ts:209
`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.	`View`.`specProps`	js-api/src/u2core/component.ts:81
`subs`	`public`	`Subscription`[]	`undefined`	Subscriptions cancelled when the widget is detached.	`View`.`subs`	js-api/src/views/view.ts:50
`temp`	`public`	`any`	`undefined`	Contains auxiliary information	`View`.`temp`	js-api/src/views/view.ts:241
`ALL_VIEW_TYPES`	`readonly`	`string`[]	`undefined`	-	`View`.`ALL_VIEW_TYPES`	js-api/src/views/view.ts:402
`APPS`	`readonly`	`"apps"`	`'apps'`	-	`View`.`APPS`	js-api/src/views/view.ts:372
`BROWSE`	`readonly`	`"browse"`	`'browse'`	-	`View`.`BROWSE`	js-api/src/views/view.ts:399
`DATA_CONNECTIONS`	`readonly`	`"connections"`	`'connections'`	-	`View`.`DATA_CONNECTIONS`	js-api/src/views/view.ts:386
`DATA_JOB_RUNS`	`readonly`	`"jobs"`	`'jobs'`	-	`View`.`DATA_JOB_RUNS`	js-api/src/views/view.ts:387
`DATA_QUERY_RUNS`	`readonly`	`"queryruns"`	`'queryruns'`	-	`View`.`DATA_QUERY_RUNS`	js-api/src/views/view.ts:389
`DATABASES`	`readonly`	`"databases"`	`'databases'`	-	`View`.`DATABASES`	js-api/src/views/view.ts:382
`DOCKERS`	`readonly`	`"dockers"`	`'dockers'`	-	`View`.`DOCKERS`	js-api/src/views/view.ts:400
`EMAILS`	`readonly`	`"emails"`	`'emails'`	-	`View`.`EMAILS`	js-api/src/views/view.ts:390
`FILES`	`readonly`	`"files"`	`'files'`	-	`View`.`FILES`	js-api/src/views/view.ts:388
`FORUM`	`readonly`	`"forum"`	`'forum'`	-	`View`.`FORUM`	js-api/src/views/view.ts:377
`FUNCTIONS`	`readonly`	`"functions"`	`'functions'`	-	`View`.`FUNCTIONS`	js-api/src/views/view.ts:385
`GROUPS`	`readonly`	`"groups"`	`'groups'`	-	`View`.`GROUPS`	js-api/src/views/view.ts:391
`HELP`	`readonly`	`"help"`	`'help'`	-	`View`.`HELP`	js-api/src/views/view.ts:380
`JS_EDITOR`	`readonly`	`"js"`	`'js'`	-	`View`.`JS_EDITOR`	js-api/src/views/view.ts:398
`MODELS`	`readonly`	`"models"`	`'models'`	-	`View`.`MODELS`	js-api/src/views/view.ts:392
`NOTEBOOKS`	`readonly`	`"notebooks"`	`'notebooks'`	-	`View`.`NOTEBOOKS`	js-api/src/views/view.ts:379
`OPEN_TEXT`	`readonly`	`"text"`	`'text'`	-	`View`.`OPEN_TEXT`	js-api/src/views/view.ts:381
`PACKAGE_REPOSITORIES`	`readonly`	`"repositories"`	`'repositories'`	-	`View`.`PACKAGE_REPOSITORIES`	js-api/src/views/view.ts:397
`PACKAGES`	`readonly`	`"packages"`	`'packages'`	-	`View`.`PACKAGES`	js-api/src/views/view.ts:396
`PROJECTS`	`readonly`	`"projects"`	`'projects'`	-	`View`.`PROJECTS`	js-api/src/views/view.ts:378
`QUERIES`	`readonly`	`"queries"`	`'queries'`	-	`View`.`QUERIES`	js-api/src/views/view.ts:393
`SCRIPT`	`readonly`	`"script"`	`'script'`	-	`View`.`SCRIPT`	js-api/src/views/view.ts:375
`SCRIPTS`	`readonly`	`"scripts"`	`'scripts'`	-	`View`.`SCRIPTS`	js-api/src/views/view.ts:394
`SETTINGS`	`readonly`	`"settings"`	`'settings'`	-	`View`.`SETTINGS`	js-api/src/views/view.ts:373
`SKETCH`	`readonly`	`"sketch"`	`'sketch'`	-	`View`.`SKETCH`	js-api/src/views/view.ts:376
`USERS`	`readonly`	`"users"`	`'users'`	-	`View`.`USERS`	js-api/src/views/view.ts:395
`VIEW_LAYOUTS`	`readonly`	`"layouts"`	`'layouts'`	-	`View`.`VIEW_LAYOUTS`	js-api/src/views/view.ts:384
`WEB_SERVICES`	`readonly`	`"webservices"`	`'webservices'`	-	`View`.`WEB_SERVICES`	js-api/src/views/view.ts:383
`WELCOME`	`readonly`	`"welcome"`	`'welcome'`	-	`View`.`WELCOME`	js-api/src/views/view.ts:374

Accessors

aiDescription

Get Signature

get aiDescription(): string | null

Defined in: js-api/src/views/view.ts:252

AI briefing of the underlying view (widget-level on the Dart side). For a JS-defined view the Dart host forwards to the original ViewBase instance.

Returns

string | null

Set Signature

set aiDescription(x): void

Defined in: js-api/src/views/view.ts:257

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

Parameters

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

Returns

void

Inherited from

View.aiDescription

ambientAdoption

Get Signature

get protected ambientAdoption(): boolean

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

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

Returns

boolean

Inherited from

View.ambientAdoption

basePath

Get Signature

get basePath(): string

Defined in: js-api/src/views/view.ts:138

URL prefix of the view (an app's root, such as /apps/Chem); path is this prefix plus the view's own relative path.

Returns

string

Set Signature

set basePath(s): void

Defined in: js-api/src/views/view.ts:139

Parameters

Parameter	Type
`s`	`string`

Returns

void

Inherited from

View.basePath

box

Get Signature

get box(): boolean

Defined in: js-api/src/views/view.ts:75

Returns

boolean

Set Signature

set box(b): void

Defined in: js-api/src/views/view.ts:76

Parameters

Parameter	Type
`b`	`boolean`

Returns

void

Inherited from

View.box

children

Get Signature

get children(): Widget<any>[]

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

Parent widget up the DOM tree, or null.

Returns

Widget<any>[]

Inherited from

View.children

closing

Get Signature

get closing(): boolean

Defined in: js-api/src/views/view.ts:156

Whether the view is currently closing.

Returns

boolean

Set Signature

set closing(c): void

Defined in: js-api/src/views/view.ts:157

Parameters

Parameter	Type
`c`	`boolean`

Returns

void

Inherited from

View.closing

dataFrame

Get Signature

get dataFrame(): DataFrame

Defined in: js-api/src/views/view.ts:443

Returns

DataFrame

Set Signature

set dataFrame(x): void

Defined in: js-api/src/views/view.ts:444

Parameters

Parameter	Type
`x`	`DataFrame`

Returns

void

description

Get Signature

get description(): string

Defined in: js-api/src/views/view.ts:325

View description. Used in UI and AI.

Returns

string

Set Signature

set description(s): void

Defined in: js-api/src/views/view.ts:326

Parameters

Parameter	Type
`s`	`string`

Returns

void

Inherited from

View.description

dockManager

Get Signature

get dockManager(): DockManager

Defined in: js-api/src/views/view.ts:485

View's dock manager. Only defined for DockView descendants such as TableView, UsersView, etc.

Returns

DockManager

dockNode

Get Signature

get dockNode(): DockNode

Defined in: js-api/src/views/view.ts:479

A dock node for this view. Use grok.shell.dockManager to manipulate it; dockManager is for controlling windows that reside inside this view.

Returns

DockNode

entity

Get Signature

get entity(): object | null

Defined in: js-api/src/views/view.ts:133

Returns

object | null

Set Signature

set entity(_e): void

Defined in: js-api/src/views/view.ts:134

Parameters

Parameter	Type
`_e`	`object` \| `null`

Returns

void

Inherited from

View.entity

grid

Get Signature

get grid(): Grid

Defined in: js-api/src/views/view.ts:436

Associated grid (spreadsheet).

Returns

Grid

helpUrl

Get Signature

get helpUrl(): string | null

Defined in: js-api/src/views/view.ts:329

Returns

string | null

View help URL.

Set Signature

set helpUrl(url): void

Defined in: js-api/src/views/view.ts:330

Parameters

Parameter	Type
`url`	`string` \| `null`

Returns

void

View help URL.

Inherited from

View.helpUrl

id

Get Signature

get id(): string

Defined in: js-api/src/views/view.ts:320

Returns

string

Inherited from

View.id

innerView

Set Signature

set innerView(v): void

Defined in: js-api/src/views/view.ts:128

The view this one is currently surfacing, if it hosts another (such as a MultiView tab). grok.shell.t resolves through it.

Parameters

Parameter	Type
`v`	`ViewBase` \| `null`

Returns

void

Inherited from

View.innerView

isPinned

Get Signature

get isPinned(): boolean

Defined in: js-api/src/views/view.ts:186

Whether the view is pinned. Pinned views are not closed when a new view is opened.

Returns

boolean

Set Signature

set isPinned(value): void

Defined in: js-api/src/views/view.ts:187

Parameters

Parameter	Type
`value`	`boolean`

Returns

void

Inherited from

View.isPinned

jsView

Get Signature

get jsView(): ViewBase | null

Defined in: js-api/src/views/view.ts:266

The original JS ViewBase instance when this view hosts a JS-defined view (e.g. a plugin app view), null for native Dart views. Lets callers reach the actual view class (its methods, tools, state) from grok.shell.v.

Returns

ViewBase | null

Inherited from

View.jsView

name

Get Signature

get name(): string

Defined in: js-api/src/views/view.ts:354

View name. It gets shown in the tab handle.

Returns

string

Set Signature

set name(s): void

Defined in: js-api/src/views/view.ts:359

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.

Parameters

Parameter	Type
`s`	`string`

Returns

void

Inherited from

SpaceView.name

parent

Get Signature

get parent(): Widget<any> | null

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

Parent widget up the DOM tree, or null.

Returns

Widget<any> | null

Inherited from

View.parent

parentCall

Get Signature

get parentCall(): FuncCall | undefined

Defined in: js-api/src/views/view.ts:120

Returns

FuncCall | undefined

Set Signature

set parentCall(s): void

Defined in: js-api/src/views/view.ts:121

Parameters

Parameter	Type
`s`	`FuncCall` \| `undefined`

Returns

void

Inherited from

MultiView.parentCall

parentView

Get Signature

get parentView(): ViewBase

Defined in: js-api/src/views/view.ts:123

Returns

ViewBase

Set Signature

set parentView(s): void

Defined in: js-api/src/views/view.ts:124

Parameters

Parameter	Type
`s`	`ViewBase`

Returns

void

Inherited from

View.parentView

path

Get Signature

get path(): string

Defined in: js-api/src/views/view.ts:182

View URI, relative to the view root

Returns

string

Set Signature

set path(s): void

Defined in: js-api/src/views/view.ts:183

Parameters

Parameter	Type
`s`	`string`

Returns

void

Inherited from

View.path

propertyTarget

Get Signature

get propertyTarget(): unknown

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

What this component's properties are read from and written to — prop.get(target) / prop.set(target, v): the component itself, unless an adoption says otherwise.

Returns

unknown

Inherited from

View.propertyTarget

propertyTier

Get Signature

get propertyTier(): boolean

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

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

Returns

boolean

Inherited from

View.propertyTier

ribbonMenu

Get Signature

get ribbonMenu(): Menu

Defined in: js-api/src/views/view.ts:148

View menu. Sample: https://public.datagrok.ai/js/samples/ui/views/ribbon

Returns

Menu

Set Signature

set ribbonMenu(menu): void

Defined in: js-api/src/views/view.ts:149

Parameters

Parameter	Type
`menu`	`Menu`

Returns

void

Inherited from

View.ribbonMenu

root

Get Signature

get root(): HTMLElement

Defined in: js-api/src/views/view.ts:312

Returns the content (visual root) of this view.

Returns

HTMLElement

Inherited from

View.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

View.scope

statusBarPanels

Get Signature

get statusBarPanels(): HTMLDivElement[]

Defined in: js-api/src/views/view.ts:152

Status bar panels to be shown on the bottom

Returns

HTMLDivElement[]

Set Signature

set statusBarPanels(panels): void

Defined in: js-api/src/views/view.ts:153

Parameters

Parameter	Type
`panels`	`HTMLDivElement`[]

Returns

void

Inherited from

View.statusBarPanels

syncCurrentObject

Get Signature

get syncCurrentObject(): boolean

Defined in: js-api/src/views/view.ts:642

Returns

boolean

Set Signature

set syncCurrentObject(x): void

Defined in: js-api/src/views/view.ts:643

Parameters

Parameter	Type
`x`	`boolean`

Returns

void

table

Get Signature

get table(): DataFrame | null

Defined in: js-api/src/views/view.ts:427

Associated table, if it exists (for TableView), or null.

Returns

DataFrame | null

Set Signature

set table(df): void

Defined in: js-api/src/views/view.ts:431

Parameters

Parameter	Type
`df`	`DataFrame` \| `null`

Returns

void

toolbox

Get Signature

get toolbox(): HTMLElement

Defined in: js-api/src/views/view.ts:143

View toolbox. Sample: https://public.datagrok.ai/js/samples/ui/views/toolbox

Returns

HTMLElement

Set Signature

set toolbox(x): void

Defined in: js-api/src/views/view.ts:144

Parameters

Parameter	Type
`x`	`HTMLElement`

Returns

void

Inherited from

View.toolbox

toolboxPage

Get Signature

get toolboxPage(): ToolboxPage

Defined in: js-api/src/views/view.ts:447

View toolbox that gets shown on the left, in the sidebar

Returns

ToolboxPage

type

Get Signature

get type(): string

Defined in: js-api/src/views/view.ts:316

View type

Returns

string

Inherited from

View.type

viewers

Get Signature

get viewers(): Viewer<any>[]

Defined in: js-api/src/views/view.ts:638

Returns all viewers. Resulting array is cloned, so cache the result and do not call repeatedly in inner loops.

Returns

Viewer<any>[]

Methods

_notifyPropertyChange()

protected _notifyPropertyChange(p): void

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

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

View._notifyPropertyChange

_onAdded()

_onAdded(): void

Defined in: js-api/src/views/view.ts:367

Returns

void

Inherited from

View._onAdded

_ownPropertyChanges()

protected _ownPropertyChanges(): ObservableLike<PropertyChange>

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

Returns

ObservableLike<PropertyChange>

Inherited from

View._ownPropertyChanges

_scopeMinted()

protected _scopeMinted(_scope): void

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

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

View._scopeMinted

_wireDartLifecycle()

protected _wireDartLifecycle(): void

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

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

Returns

void

Inherited from

View._wireDartLifecycle

_wireJsLifecycle()

protected _wireJsLifecycle(): void

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

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

Returns

void

Inherited from

View._wireJsLifecycle

_wireLifecycle()

protected _wireLifecycle(): void

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

Returns

void

Inherited from

View._wireLifecycle

acceptsPath()

acceptsPath(_urlPath): boolean

Defined in: js-api/src/views/view.ts:207

Checks if URL path is acceptable. Override in subclasses. [_urlPath] is the path WITHOUT the query string: a view claims a URL by its path, and decides what the parameters mean in handlePath.

Parameters

Parameter	Type
`_urlPath`	`string`

Returns

boolean

"true" if path is acceptable, "false" otherwise.

Inherited from

View.acceptsPath

addProperty()

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

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

Registers an property with the specified type, name, and defaultValue.

Parameters

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

Returns

any

See

Registered property gets added to properties. Returns default value, thus allowing to combine registering a property with the initialization

options.get/options.set override how the property reads/writes (instead of the default fieldName field access); the change notification (onPropertyChanged) always fires on write, and a {get}-only options yields a custom read with the default fieldName write.

Inherited from

View.addProperty

addStatusProvider()

addStatusProvider(name, provider): void

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

Adds live parts, hit areas and readings to this widget's status. Providers run in registration order on every read; an existing name is replaced in place, and later providers override earlier entries. Coordinates use the widget's own hit-area system. Detaching the widget removes all providers. A subclass that overrides getWidgetStatus composes with super.getWidgetStatus().

Parameters

Parameter	Type	Description
`name`	`string`	Stable name of the component contributing the status.
`provider`	`StatusProvider`	Computes the contribution each time the status is requested.

Returns

void

Example

widget.addStatusProvider('selection', () => ({values: {'selected rows': table.selection.trueCount}}));
console.log(widget.getWidgetStatus().values?.['selected rows']);
widget.removeStatusProvider('selection');
see samples/grid/custom-renderer-status

Inherited from

View.addStatusProvider

addViewer()

Call Signature

addViewer<T>(v, options?): ViewerClass<T>

Defined in: js-api/src/views/view.ts:453

Adds a viewer of the specified type; a known VIEWER type returns that viewer's class (see Viewer.fromType). The histogram(), scatterPlot(), ... shorthands are the typed forms.

Type Parameters

Type Parameter
`T` extends `ViewerType`

Parameters

Parameter	Type
`v`	`T`
`options?`	`any`

Returns

ViewerClass<T>

Call Signature

addViewer(v, options?): Viewer

Defined in: js-api/src/views/view.ts:454

Adds a viewer of the specified type; a known VIEWER type returns that viewer's class (see Viewer.fromType). The histogram(), scatterPlot(), ... shorthands are the typed forms.

Parameters

Parameter	Type
`v`	`Viewer`
`options?`	`any`

Returns

Viewer

afterPersist()

protected afterPersist(): void

Defined in: js-api/src/views/view.ts:101

Gets called automatically when this view gets pinned

Returns

void

Inherited from

View.afterPersist

append()

append(item): HTMLElement

Defined in: js-api/src/views/view.ts:211

Appends an item to this view. Use appendAll for appending multiple elements.

Parameters

Parameter	Type
`item`	`any`

Returns

HTMLElement

Inherited from

View.append

appendAll()

appendAll(items): HTMLElement

Defined in: js-api/src/views/view.ts:217

Appends multiple elements this view. Use append for appending a single element.

Parameters

Parameter	Type
`items`	`HTMLElement`[]

Returns

HTMLElement

Inherited from

View.appendAll

apply()

apply(properties): Widget

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

Parameters

Parameter	Type
`properties`	`object`

Returns

Widget

Inherited from

View.apply

barChart()

barChart(options?): BarChartViewer

Defined in: js-api/src/views/view.ts:497

Adds a bar chart. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/bar-chart

Parameters

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

Returns

BarChartViewer

bindProps()

bindProps(): BindProp[]

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

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

View.bindProps

bindStep()

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

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

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

View.bindStep

boxPlot()

boxPlot(options?): BoxPlot

Defined in: js-api/src/views/view.ts:503

Adds a box plot. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/box-plot

Parameters

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

Returns

BoxPlot

calendar()

calendar(options?): CalendarViewer

Defined in: js-api/src/views/view.ts:509

Adds a calendar. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/calendar

Parameters

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

Returns

CalendarViewer

close()

close(): void

Defined in: js-api/src/views/view.ts:227

Closes this view.

Returns

void

Inherited from

View.close

closeAllViewers()

closeAllViewers(): void

Defined in: js-api/src/views/view.ts:471

Closes all viewers in this view, including minimized ones.

Returns

void

corrPlot()

corrPlot(options?): CorrelationPlot

Defined in: js-api/src/views/view.ts:515

Adds a correlation plot. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/corr-plot

Parameters

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

Returns

CorrelationPlot

densityPlot()

densityPlot(options?): DensityPlotViewer

Defined in: js-api/src/views/view.ts:521

Adds a density plot. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/density-plot

Parameters

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

Returns

DensityPlotViewer

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

View.deriveName

detach()

detach(): void

Defined in: js-api/src/views/view.ts:627

Detaches and closes the view.

Returns

void

Overrides

View.detach

detachViewers()

detachViewers(): void

Defined in: js-api/src/views/view.ts:632

Detaches all viewers.

Returns

void

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

View.dispose

effect()

effect(fn): this

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

Parameters

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

Returns

this

Inherited from

View.effect

filters()

filters(options?): FilterGroup

Defined in: js-api/src/views/view.ts:527

Adds filters. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/filters

Parameters

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

Returns

FilterGroup

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

View.fireEvent

focus()

focus(): void

Defined in: js-api/src/views/view.ts:474

Moves keyboard focus to the grid of this view.

Returns

void

form()

form(options?): FormViewer

Defined in: js-api/src/views/view.ts:533

Adds default form. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/form

Parameters

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

Returns

FormViewer

getDartProperties()

getDartProperties(): any[]

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

Dart handles of the properties that have one.

Returns

any[]

Inherited from

View.getDartProperties

getFiltersGroup()

getFiltersGroup(options?): FilterGroup

Defined in: js-api/src/views/view.ts:439

Returns existing, or creates a new filter group.

Parameters

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

Returns

FilterGroup

getFunctions()

getFunctions(): Func[]

Defined in: js-api/src/views/view.ts:309

Functions that are applicable to this particular widget. Used in the UI to display context actions, and for the AI integrations.

Returns

Func[]

Inherited from

View.getFunctions

getIcon()

getIcon(): HTMLElement | null

Defined in: js-api/src/views/view.ts:171

Returns

HTMLElement | null

View icon. Override in subclasses.

Inherited from

View.getIcon

getInfo()

getInfo(): ViewLayout

Defined in: js-api/src/views/view.ts:349

Saves view as a ViewInfo. Only applicable to certain views, such as TableView.

Returns

ViewLayout

Inherited from

View.getInfo

getProperties()

getProperties(): Property[]

Defined in: js-api/src/views/view.ts:308

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

Returns

Property[]

Inherited from

View.getProperties

getRibbonPanels()

getRibbonPanels(): HTMLElement[][]

Defined in: js-api/src/views/view.ts:166

Returns

HTMLElement[][]

Inherited from

View.getRibbonPanels

getViewerColumns()

getViewerColumns(): Column<any, any>[]

Defined in: js-api/src/views/view.ts:468

Returns columns that are explicitly used as data columns in non-grid viewers (falls back to grid columns when no custom viewers are present).

Returns

Column<any, any>[]

getWidgetStatus()

getWidgetStatus(): IWidgetStatus

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

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

Returns

IWidgetStatus

Inherited from

View.getWidgetStatus

handlePath()

handlePath(_urlPath): void

Defined in: js-api/src/views/view.ts:201

Handles URL path. Override in subclasses.

[_urlPath] is the path WITHOUT the query string (see acceptsPath); the router has already updated the address bar, so read the parameters from window.location.search.

A handler may route elsewhere — set grok.shell.v to another view and the router leaves it alone (it only falls back to this view when the handler changed nothing).

Parameters

Parameter	Type
`_urlPath`	`string`

Returns

void

Inherited from

View.handlePath

heatMap()

heatMap(options?): Grid

Defined in: js-api/src/views/view.ts:539

Adds a heat map. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/heat-map

Parameters

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

Returns

Grid

histogram()

histogram(options?): HistogramViewer

Defined in: js-api/src/views/view.ts:491

Adds a histogram. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/histogram

Parameters

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

Returns

HistogramViewer

lineChart()

lineChart(options?): LineChartViewer

Defined in: js-api/src/views/view.ts:545

Adds a line chart. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/line-chart

Parameters

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

Returns

LineChartViewer

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

View.link

loadLayout()

loadLayout(layout, pickupColumnTags?): void

Defined in: js-api/src/views/view.ts:336

Loads previously saved view layout. Only applicable to certain views, such as TableView. See also saveLayout

Parameters

Parameter	Type
`layout`	`ViewLayout`
`pickupColumnTags?`	`boolean`

Returns

void

Inherited from

View.loadLayout

loadState()

loadState(x, options?): void

Defined in: js-api/src/views/view.ts:649

Parameters

Parameter	Type
`x`	`string`
`options?`	`IViewStateApplicationOptions`

Returns

void

loadStateMap()

loadStateMap(_stateMap): void

Defined in: js-api/src/views/view.ts:179

Loads view state map. Override in subclasses.

Parameters

Parameter	Type
`_stateMap`	`object`

Returns

void

Inherited from

View.loadStateMap

markup()

markup(options?): Viewer

Defined in: js-api/src/views/view.ts:557

Adds a markup viewer. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/markup

Parameters

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

Returns

Viewer

matrixPlot()

matrixPlot(options?): MatrixPlot

Defined in: js-api/src/views/view.ts:563

Adds a matrix plot. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/matrix-plot

Parameters

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

Returns

MatrixPlot

networkDiagram()

networkDiagram(options?): NetworkDiagramViewer

Defined in: js-api/src/views/view.ts:569

Adds a network diagram. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/network-diagram

Parameters

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

Returns

NetworkDiagramViewer

onEvent()

onEvent(eventId?): Observable<any>

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

Observes events with the specified eventId. Override in subclasses to provide actual events.

Parameters

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

Returns

Observable<any>

Inherited from

View.onEvent

onFrameAttached()

onFrameAttached(dataFrame): void

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

Called when a DataFrame is attached; override to bind data.

Parameters

Parameter	Type
`dataFrame`	`DataFrame`

Returns

void

Inherited from

View.onFrameAttached

onPropertyChanged()

onPropertyChanged(property): void

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

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

View.onPropertyChanged

own()

own(dispose): this

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

Parameters

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

Returns

this

Inherited from

View.own

pcPlot()

pcPlot(options?): PcPlot

Defined in: js-api/src/views/view.ts:575

Adds a parallel coordinates plot. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/pc-plot

Parameters

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

Returns

PcPlot

pieChart()

pieChart(options?): PieChartViewer

Defined in: js-api/src/views/view.ts:581

Adds a pie chart. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/pie-chart

Parameters

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

Returns

PieChartViewer

pin()

pin(): void

Defined in: js-api/src/views/view.ts:190

Pins the view. Pinned views are not closed when a new view is opened.

Returns

void

Inherited from

View.pin

propertyChanges()

protected propertyChanges(): ObservableLike<PropertyChange>

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

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

Returns

ObservableLike<PropertyChange>

Inherited from

View.propertyChanges

registerFunction()

protected registerFunction(f): void

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

Parameters

Parameter	Type
`f`	`FuncLike`

Returns

void

Inherited from

View.registerFunction

reloadData()

reloadData(options?): Promise<void>

Defined in: js-api/src/views/view.ts:654

Re-runs the table creation script (for dynamic data), and executes post-processing if enrich is true.

Parameters

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

Returns

Promise<void>

removeStatusProvider()

removeStatusProvider(name): void

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

Removes the status contribution registered under name; an absent name is a no-op.

Parameters

Parameter	Type	Description
`name`	`string`	The name passed to addStatusProvider.

Returns

void

Example

widget.removeStatusProvider('selection');
see samples/grid/custom-renderer-status

Inherited from

View.removeStatusProvider

resetLayout()

resetLayout(): void

Defined in: js-api/src/views/view.ts:622

Resets view layout, leaving only grid visible.

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

View.runInScope

saveLayout()

saveLayout(options?): ViewLayout

Defined in: js-api/src/views/view.ts:343

Saves view layout as a string. Only applicable to certain views, such as TableView. See also loadLayout

Parameters

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

Returns

ViewLayout

Inherited from

View.saveLayout

saveState()

saveState(): string

Defined in: js-api/src/views/view.ts:645

Returns

string

saveStateMap()

saveStateMap(): object | null

Defined in: js-api/src/views/view.ts:176

Returns

object | null

Viewer state map. Override in subclasses.

Inherited from

View.saveStateMap

scatterPlot()

scatterPlot(options?): ScatterPlotViewer

Defined in: js-api/src/views/view.ts:587

Adds a scatter plot. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/scatter-plot

Parameters

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

Returns

ScatterPlotViewer

scatterPlot3d()

scatterPlot3d(options?): Viewer

Defined in: js-api/src/views/view.ts:593

Adds a 3D scatter plot. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/scatter-plot-3d

Parameters

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

Returns

Viewer

setIcon()

setIcon(icon): void

Defined in: js-api/src/views/view.ts:173

Parameters

Parameter	Type
`icon`	`HTMLElement`

Returns

void

Inherited from

View.setIcon

setRibbonPanels()

setRibbonPanels(panels, clear?): void

Defined in: js-api/src/views/view.ts:162

Sets custom view panels on the ribbon.

Parameters

Parameter	Type	Default value	Description
`panels`	`HTMLElement`[][]	`undefined`	-
`clear`	`boolean`	`true`	Clear all previous before setup Sample: https://public.datagrok.ai/js/samples/ui/views/ribbon

Returns

void

Inherited from

View.setRibbonPanels

shapeMap()

shapeMap(options?): Viewer

Defined in: js-api/src/views/view.ts:551

Adds a shape map. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/shape-map

Parameters

Parameter	Type
`options?`	`Partial`<`IMapViewerSettings`>

Returns

Viewer

sourceRowsChanged()

sourceRowsChanged(): void

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

Called when the rows the widget shows change; override to refresh.

Returns

void

Inherited from

View.sourceRowsChanged

statistics()

statistics(options?): Viewer

Defined in: js-api/src/views/view.ts:599

Adds a statistics. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/statistics

Parameters

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

Returns

Viewer

sub()

sub(subscription): void

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

Registers a subscription to an external event.

Parameters

Parameter	Type
`subscription`	`Subscription`

Returns

void

Inherited from

View.sub

tileViewer()

tileViewer(options?): TileViewer

Defined in: js-api/src/views/view.ts:605

Adds a tile viewer. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/tile-viewer

Parameters

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

Returns

TileViewer

toDart()

toDart(): any

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

The Dart handle of this widget, created on first use.

Returns

any

Inherited from

View.toDart

treeMap()

treeMap(options?): TreeMap

Defined in: js-api/src/views/view.ts:611

Adds a tree map. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/tree-map

Parameters

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

Returns

TreeMap

trellisPlot()

trellisPlot(options?): TrellisPlotViewer

Defined in: js-api/src/views/view.ts:617

Adds a trellis plot. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/trellis-plot

Parameters

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

Returns

TrellisPlotViewer

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

View.build

create()

static create(table, addToWorkspace?): TableView

Defined in: js-api/src/views/view.ts:422

Creates a new table view, and adds it to the workspace if specified

Parameters

Parameter	Type	Default value
`table`	`DataFrame`	`undefined`
`addToWorkspace`	`boolean`	`true`

Returns

TableView

Overrides

View.create

createByType()

static createByType(viewType, options?): View

Defined in: js-api/src/views/view.ts:300

Creates one of the standard views based on the view type (such as 'functions')

Parameters

Parameter	Type
`viewType`	`string` \| `string` & `object`
`options?`	`any`

Returns

View

Inherited from

View.createByType

find()

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

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

Finds existing widget from its visual root.

Parameters

Parameter	Type
`root`	`Element`

Returns

Widget<any> | null

Inherited from

View.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

View.forElement

forObject()

static forObject(x): View | null

Defined in: js-api/src/views/view.ts:280

Creates a view for the specified object, if it is registered, or null otherwise.

Parameters

Parameter	Type
`x`	`any`

Returns

View | null

Inherited from

View.forObject

fromDart()

static fromDart(dart): TableView | View

Defined in: js-api/src/views/view.ts:271

Parameters

Parameter	Type
`dart`	`any`

Returns

TableView | View

Inherited from

View.fromDart

fromRoot()

static fromRoot(root): View

Defined in: js-api/src/views/view.ts:285

Creates and returns a view with the specified element inside.

Parameters

Parameter	Type
`root`	`HTMLElement`

Returns

View

Inherited from

View.fromRoot

fromViewAsync()

static fromViewAsync(getViewAsync, ribbon?): any

Defined in: js-api/src/views/view.ts:304

Parameters

Parameter	Type	Default value
`getViewAsync`	() => `Promise`<`View`>	`undefined`
`ribbon`	`boolean`	`true`

Returns

any

Inherited from

View.fromViewAsync

getAll()

static getAll(): Widget<any>[]

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

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

View.getAll

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

View.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

View.is

registerCleanup()

static registerCleanup(element, cleanup): void

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

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`	`Callback`

Returns

void

Inherited from

View.registerCleanup

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

View.sameValue

Extends​

Constructors​

Constructor​

Parameters​

Returns​

Overrides​

Properties​

Accessors​

aiDescription​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

ambientAdoption​

Get Signature​

Returns​

Inherited from​

basePath​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

box​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

children​

Get Signature​

Returns​

Inherited from​

closing​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

dataFrame​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

description​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

dockManager​

Get Signature​

Returns​

dockNode​

Get Signature​

Returns​

entity​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

grid​

Get Signature​

Returns​

helpUrl​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

Extends

Constructors

Constructor

Parameters

Returns

Overrides

Properties

Accessors

aiDescription

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

ambientAdoption

Get Signature

Returns

Inherited from

basePath

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

box

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

children

Get Signature

Returns

Inherited from

closing

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

dataFrame

Get Signature

Returns

Set Signature

Parameters

Returns

description

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

dockManager

Get Signature

Returns

dockNode

Get Signature

Returns

entity

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

grid

Get Signature

Returns

helpUrl

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from