TableView

Defined in: src/views/view.ts:413

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: src/views/view.ts:415

Parameters

Parameter	Type
`dart`	`any`

Returns

TableView

Constructs

TableView

Overrides

View.constructor

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
`_functions`	`protected`	`Func`[]	`[]`	-	`View`.`_functions`	src/widgets/base.ts:243
`_name`	`protected`	`string`	`'New View'`	-	`View`.`_name`	src/views/view.ts:106
`_properties`	`protected`	`Property`[]	`[]`	-	`View`.`_properties`	src/widgets/base.ts:242
`_root`	`protected`	`HTMLElement`	`undefined`	-	`View`.`_root`	src/widgets/base.ts:241
`dart`	`public`	`any`	`undefined`	-	`View`.`dart`	src/views/view.ts:46
`factory`	`public`	`Func` \| `null`	`null`	Constructor function. No parameters, returns [Widget].	`View`.`factory`	src/widgets/base.ts:239
`isDetached`	`public`	`boolean`	`false`	-	`View`.`isDetached`	src/widgets/base.ts:247
`props`	`public`	`any`	`undefined`	-	`View`.`props`	src/widgets/base.ts:244
`subs`	`public`	`Subscription`[]	`undefined`	-	`View`.`subs`	src/views/view.ts:47
`temp`	`public`	`any`	`undefined`	Contains auxiliary information	`View`.`temp`	src/views/view.ts:226
`ALL_VIEW_TYPES`	`readonly`	`string`[]	`undefined`	-	`View`.`ALL_VIEW_TYPES`	src/views/view.ts:398
`APPS`	`readonly`	`"apps"`	`'apps'`	-	`View`.`APPS`	src/views/view.ts:368
`BROWSE`	`readonly`	`"browse"`	`'browse'`	-	`View`.`BROWSE`	src/views/view.ts:395
`DATA_CONNECTIONS`	`readonly`	`"connections"`	`'connections'`	-	`View`.`DATA_CONNECTIONS`	src/views/view.ts:382
`DATA_JOB_RUNS`	`readonly`	`"jobs"`	`'jobs'`	-	`View`.`DATA_JOB_RUNS`	src/views/view.ts:383
`DATA_QUERY_RUNS`	`readonly`	`"queryruns"`	`'queryruns'`	-	`View`.`DATA_QUERY_RUNS`	src/views/view.ts:385
`DATABASES`	`readonly`	`"databases"`	`'databases'`	-	`View`.`DATABASES`	src/views/view.ts:378
`DOCKERS`	`readonly`	`"dockers"`	`'dockers'`	-	`View`.`DOCKERS`	src/views/view.ts:396
`EMAILS`	`readonly`	`"emails"`	`'emails'`	-	`View`.`EMAILS`	src/views/view.ts:386
`FILES`	`readonly`	`"files"`	`'files'`	-	`View`.`FILES`	src/views/view.ts:384
`FORUM`	`readonly`	`"forum"`	`'forum'`	-	`View`.`FORUM`	src/views/view.ts:373
`FUNCTIONS`	`readonly`	`"functions"`	`'functions'`	-	`View`.`FUNCTIONS`	src/views/view.ts:381
`GROUPS`	`readonly`	`"groups"`	`'groups'`	-	`View`.`GROUPS`	src/views/view.ts:387
`HELP`	`readonly`	`"help"`	`'help'`	-	`View`.`HELP`	src/views/view.ts:376
`JS_EDITOR`	`readonly`	`"js"`	`'js'`	-	`View`.`JS_EDITOR`	src/views/view.ts:394
`MODELS`	`readonly`	`"models"`	`'models'`	-	`View`.`MODELS`	src/views/view.ts:388
`NOTEBOOKS`	`readonly`	`"notebooks"`	`'notebooks'`	-	`View`.`NOTEBOOKS`	src/views/view.ts:375
`OPEN_TEXT`	`readonly`	`"text"`	`'text'`	-	`View`.`OPEN_TEXT`	src/views/view.ts:377
`PACKAGE_REPOSITORIES`	`readonly`	`"repositories"`	`'repositories'`	-	`View`.`PACKAGE_REPOSITORIES`	src/views/view.ts:393
`PACKAGES`	`readonly`	`"packages"`	`'packages'`	-	`View`.`PACKAGES`	src/views/view.ts:392
`PROJECTS`	`readonly`	`"projects"`	`'projects'`	-	`View`.`PROJECTS`	src/views/view.ts:374
`QUERIES`	`readonly`	`"queries"`	`'queries'`	-	`View`.`QUERIES`	src/views/view.ts:389
`SCRIPT`	`readonly`	`"script"`	`'script'`	-	`View`.`SCRIPT`	src/views/view.ts:371
`SCRIPTS`	`readonly`	`"scripts"`	`'scripts'`	-	`View`.`SCRIPTS`	src/views/view.ts:390
`SETTINGS`	`readonly`	`"settings"`	`'settings'`	-	`View`.`SETTINGS`	src/views/view.ts:369
`SKETCH`	`readonly`	`"sketch"`	`'sketch'`	-	`View`.`SKETCH`	src/views/view.ts:372
`USERS`	`readonly`	`"users"`	`'users'`	-	`View`.`USERS`	src/views/view.ts:391
`VIEW_LAYOUTS`	`readonly`	`"layouts"`	`'layouts'`	-	`View`.`VIEW_LAYOUTS`	src/views/view.ts:380
`WEB_SERVICES`	`readonly`	`"webservices"`	`'webservices'`	-	`View`.`WEB_SERVICES`	src/views/view.ts:379
`WELCOME`	`readonly`	`"welcome"`	`'welcome'`	-	`View`.`WELCOME`	src/views/view.ts:370

Accessors

aiDescription

Get Signature

get aiDescription(): string | null

Defined in: src/views/view.ts:237

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: src/views/view.ts:242

A short AI-facing briefing: what this widget is, what its functions do, and how the assistant should approach it (e.g. which getFunctions entries to call first). Shown to the AI assistant as part of the workspace context.

Parameters

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

Returns

void

Inherited from

View.aiDescription

basePath

Get Signature

get basePath(): string

Defined in: src/views/view.ts:131

Deprecated

use path instead

Returns

string

Set Signature

set basePath(s): void

Defined in: src/views/view.ts:132

Parameters

Parameter	Type
`s`	`string`

Returns

void

Inherited from

View.basePath

box

Get Signature

get box(): boolean

Defined in: src/views/view.ts:73

Returns

boolean

Set Signature

set box(b): void

Defined in: src/views/view.ts:74

Parameters

Parameter	Type
`b`	`boolean`

Returns

void

Inherited from

View.box

children

Get Signature

get children(): Widget<any>[]

Defined in: src/widgets/base.ts:328

Parent widget up the DOM tree, or null.

Returns

Widget<any>[]

Inherited from

View.children

closing

Get Signature

get closing(): boolean

Defined in: src/views/view.ts:149

Whether the view is currently closing.

Returns

boolean

Set Signature

set closing(c): void

Defined in: src/views/view.ts:150

Parameters

Parameter	Type
`c`	`boolean`

Returns

void

Inherited from

View.closing

dataFrame

Get Signature

get dataFrame(): DataFrame

Defined in: src/views/view.ts:441

Returns

DataFrame

Set Signature

set dataFrame(x): void

Defined in: src/views/view.ts:442

Parameters

Parameter	Type
`x`	`DataFrame`

Returns

void

description

Get Signature

get description(): string

Defined in: src/views/view.ts:312

View description. Used in UI and AI.

Returns

string

Set Signature

set description(s): void

Defined in: src/views/view.ts:313

Parameters

Parameter	Type
`s`	`string`

Returns

void

Inherited from

View.description

dockManager

Get Signature

get dockManager(): DockManager

Defined in: src/views/view.ts:482

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

Returns

DockManager

dockNode

Get Signature

get dockNode(): DockNode

Defined in: src/views/view.ts:475

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: src/views/view.ts:127

Returns

object | null

Set Signature

set entity(_e): void

Defined in: src/views/view.ts:128

Parameters

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

Returns

void

Inherited from

View.entity

grid

Get Signature

get grid(): Grid

Defined in: src/views/view.ts:434

Associated grid (spreadsheet).

Returns

Grid

helpUrl

Get Signature

get helpUrl(): string | null

Defined in: src/views/view.ts:316

Returns

string | null

View help URL.

Set Signature

set helpUrl(url): void

Defined in: src/views/view.ts:317

Parameters

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

Returns

void

View help URL.

Inherited from

View.helpUrl

id

Get Signature

get id(): string

Defined in: src/views/view.ts:307

Returns

string

Inherited from

View.id

isPinned

Get Signature

get isPinned(): boolean

Defined in: src/views/view.ts:320

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: src/views/view.ts:321

Parameters

Parameter	Type
`value`	`boolean`

Returns

void

Inherited from

View.isPinned

jsView

Get Signature

get jsView(): ViewBase | null

Defined in: src/views/view.ts:251

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: src/views/view.ts:350

View name. It gets shown in the tab handle.

Returns

string

Set Signature

set name(s): void

Defined in: src/views/view.ts:355

Parameters

Parameter	Type
`s`	`string`

Returns

void

Inherited from

SpaceView.name

parent

Get Signature

get parent(): Widget<any> | null

Defined in: src/widgets/base.ts:325

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: src/views/view.ts:118

Returns

FuncCall | undefined

Set Signature

set parentCall(s): void

Defined in: src/views/view.ts:119

Parameters

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

Returns

void

Inherited from

MultiView.parentCall

parentView

Get Signature

get parentView(): ViewBase

Defined in: src/views/view.ts:121

Returns

ViewBase

Set Signature

set parentView(s): void

Defined in: src/views/view.ts:122

Parameters

Parameter	Type
`s`	`ViewBase`

Returns

void

Inherited from

View.parentView

path

Get Signature

get path(): string

Defined in: src/views/view.ts:176

View URI, relative to the view root

Returns

string

Set Signature

set path(s): void

Defined in: src/views/view.ts:177

Parameters

Parameter	Type
`s`	`string`

Returns

void

Inherited from

View.path

ribbonMenu

Get Signature

get ribbonMenu(): Menu

Defined in: src/views/view.ts:141

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

Returns

Menu

Set Signature

set ribbonMenu(menu): void

Defined in: src/views/view.ts:142

Parameters

Parameter	Type
`menu`	`Menu`

Returns

void

Inherited from

View.ribbonMenu

root

Get Signature

get root(): HTMLElement

Defined in: src/views/view.ts:299

Returns the content (visual root) of this view.

Returns

HTMLElement

Inherited from

View.root

statusBarPanels

Get Signature

get statusBarPanels(): HTMLDivElement[]

Defined in: src/views/view.ts:145

Status bar panels to be shown on the bottom

Returns

HTMLDivElement[]

Set Signature

set statusBarPanels(panels): void

Defined in: src/views/view.ts:146

Parameters

Parameter	Type
`panels`	`HTMLDivElement`[]

Returns

void

Inherited from

View.statusBarPanels

syncCurrentObject

Get Signature

get syncCurrentObject(): boolean

Defined in: src/views/view.ts:672

Returns

boolean

Set Signature

set syncCurrentObject(x): void

Defined in: src/views/view.ts:673

Parameters

Parameter	Type
`x`	`boolean`

Returns

void

table

Get Signature

get table(): DataFrame | null

Defined in: src/views/view.ts:425

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

Returns

DataFrame | null

Set Signature

set table(df): void

Defined in: src/views/view.ts:429

Parameters

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

Returns

void

toolbox

Get Signature

get toolbox(): HTMLElement

Defined in: src/views/view.ts:136

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

Returns

HTMLElement

Set Signature

set toolbox(x): void

Defined in: src/views/view.ts:137

Parameters

Parameter	Type
`x`	`HTMLElement`

Returns

void

Inherited from

View.toolbox

toolboxPage

Get Signature

get toolboxPage(): ToolboxPage

Defined in: src/views/view.ts:445

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

Returns

ToolboxPage

type

Get Signature

get type(): string

Defined in: src/views/view.ts:303

View type

Returns

string

Inherited from

View.type

viewers

Get Signature

get viewers(): Viewer<any>[]

Defined in: src/views/view.ts:668

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

Returns

Viewer<any>[]

Methods

_onAdded()

_onAdded(): void

Defined in: src/views/view.ts:363

Returns

void

Inherited from

View._onAdded

acceptsPath()

acceptsPath(_urlPath): boolean

Defined in: src/views/view.ts:190

Checks if URL path is acceptable. Override in subclasses.

Parameters

Parameter	Type
`_urlPath`	`string`

Returns

boolean

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

Inherited from

View.acceptsPath

addViewer()

addViewer(v, options?): Viewer

Defined in: src/views/view.ts:450

Adds a viewer of the specified type.

Parameters

Parameter	Type
`v`	`string` \| `Viewer`<`any`>
`options?`	`any`

Returns

Viewer

afterPersist()

protected afterPersist(): void

Defined in: src/views/view.ts:99

Gets called automatically when this view gets pinned

Returns

void

Inherited from

View.afterPersist

append()

append(item): HTMLElement

Defined in: src/views/view.ts:195

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

Parameters

Parameter	Type	Description
`item`	`any`	-

Returns

HTMLElement

Inherited from

View.append

appendAll()

appendAll(items): HTMLElement

Defined in: src/views/view.ts:202

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

Parameters

Parameter	Type	Description
`items`	`HTMLElement`[]	-

Returns

HTMLElement

Inherited from

View.appendAll

apply()

apply(properties): Widget

Defined in: src/widgets/base.ts:284

Parameters

Parameter	Type	Description
`properties`	`object`	-

Returns

Widget

Inherited from

View.apply

barChart()

barChart(options?): Viewer

Defined in: src/views/view.ts:497

deprecated: use addViewer(Viewer.barChart(options)) Adds a bar chart. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/bar-chart

Parameters

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

Returns

Viewer

boxPlot()

boxPlot(options?): Viewer

Defined in: src/views/view.ts:504

deprecated: use addViewer(Viewer.boxPlot(options)) Adds a box plot. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/box-plot

Parameters

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

Returns

Viewer

calendar()

calendar(options?): Viewer

Defined in: src/views/view.ts:513

deprecated: use addViewer(Viewer.calendar(options)) Adds a calendar. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/calendar

Parameters

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

Returns

Viewer

close()

close(): void

Defined in: src/views/view.ts:212

Closes this view.

Returns

void

Inherited from

View.close

closeAllViewers()

closeAllViewers(): void

Defined in: src/views/view.ts:466

Closes all viewers in this view, including minimized ones.

Returns

void

corrPlot()

corrPlot(options?): Viewer

Defined in: src/views/view.ts:520

deprecated: use addViewer(Viewer.corrPlot(options)) Adds a correlation plot. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/corr-plot

Parameters

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

Returns

Viewer

densityPlot()

densityPlot(options?): Viewer

Defined in: src/views/view.ts:527

deprecated: use addViewer(Viewer.densityPlot(options)) Adds a density plot. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/density-plot

Parameters

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

Returns

Viewer

detach()

detach(): void

Defined in: src/views/view.ts:657

Detaches and closes the view.

Returns

void

Overrides

View.detach

detachViewers()

detachViewers(): void

Defined in: src/views/view.ts:662

Detaches all viewers.

Returns

void

filters()

filters(options?): Viewer

Defined in: src/views/view.ts:534

deprecated: use addViewer(Viewer.filters(options)) Adds filters. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/filters

Parameters

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

Returns

Viewer

focus()

focus(): void

Defined in: src/views/view.ts:469

Moves keyboard focus to the grid of this view.

Returns

void

form()

form(options?): Viewer

Defined in: src/views/view.ts:541

deprecated: use addViewer(Viewer.form(options)) Adds default form. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/form

Parameters

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

Returns

Viewer

getDartProperties()

getDartProperties(): any[]

Defined in: src/widgets/base.ts:313

Returns

any[]

Inherited from

View.getDartProperties

getFiltersGroup()

getFiltersGroup(options?): FilterGroup

Defined in: src/views/view.ts:437

Returns existing, or creates a new filter group.

Parameters

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

Returns

FilterGroup

getFunctions()

getFunctions(): Func[]

Defined in: src/views/view.ts:296

Functions applicable to this view. Override in subclasses to return the view's registered package functions — each typically takes the generic view argument and reaches this instance through view.jsView. The Dart JsViewHost forwards its own getFunctions() here, so callers holding grok.shell.v see these functions.

Returns

Func[]

Inherited from

View.getFunctions

getIcon()

getIcon(): HTMLElement | null

Defined in: src/views/view.ts:165

Returns

HTMLElement | null

View icon. Override in subclasses.

Inherited from

View.getIcon

getInfo()

getInfo(): ViewLayout

Defined in: src/views/view.ts:344

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

Returns

ViewLayout

Inherited from

View.getInfo

getProperties()

getProperties(): Property[]

Defined in: src/views/view.ts:295

Returns all properties of this widget.

Returns

Property[]

Inherited from

View.getProperties

getRibbonPanels()

getRibbonPanels(): HTMLElement[][]

Defined in: src/views/view.ts:160

Returns

HTMLElement[][]

Inherited from

View.getRibbonPanels

getViewerColumns()

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

Defined in: src/views/view.ts:463

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: src/widgets/base.ts:379

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

Returns

IWidgetStatus

Inherited from

View.getWidgetStatus

handlePath()

handlePath(_urlPath): void

Defined in: src/views/view.ts:186

Handles URL path. Override in subclasses.

Parameters

Parameter	Type
`_urlPath`	`string`

Returns

void

Inherited from

View.handlePath

heatMap()

heatMap(options?): Viewer

Defined in: src/views/view.ts:548

deprecated: use addViewer(Viewer.heatMap(options)) Adds a heat map. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/heat-map

Parameters

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

Returns

Viewer

histogram()

histogram(options?): Viewer

Defined in: src/views/view.ts:490

This and some of the following methods are "softly deprecated" (will likely be deprecated in 1.21): deprecated: use addViewer(Viewer.histogram(options)). Adds a histogram. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/histogram

Parameters

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

Returns

Viewer

lineChart()

lineChart(options?): Viewer

Defined in: src/views/view.ts:555

deprecated: use addViewer(Viewer.histogram(options)) Adds a line chart. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/line-chart

Parameters

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

Returns

Viewer

loadLayout()

loadLayout(layout, pickupColumnTags?): void

Defined in: src/views/view.ts:329

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: src/views/view.ts:679

Parameters

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

Returns

void

loadStateMap()

loadStateMap(_stateMap): void

Defined in: src/views/view.ts:173

Loads view state map. Override in subclasses.

Parameters

Parameter	Type
`_stateMap`	`object`

Returns

void

Inherited from

View.loadStateMap

markup()

markup(options?): Viewer

Defined in: src/views/view.ts:569

deprecated: use addViewer(Viewer.markup(options)) 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?): Viewer

Defined in: src/views/view.ts:576

deprecated: use addViewer(Viewer.matrixPlot(options)) Adds a matrix plot. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/matrix-plot

Parameters

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

Returns

Viewer

networkDiagram()

networkDiagram(options?): Viewer

Defined in: src/views/view.ts:583

deprecated: use addViewer(Viewer.networkDiagram(options)) Adds a network diagram. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/network-diagram

Parameters

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

Returns

Viewer

onEvent()

onEvent(eventId?): Observable<any>

Defined in: src/widgets/base.ts:376

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: src/widgets/base.ts:319

Parameters

Parameter	Type
`dataFrame`	`DataFrame`

Returns

void

Inherited from

View.onFrameAttached

onPropertyChanged()

onPropertyChanged(property): void

Defined in: src/widgets/base.ts:311

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

pcPlot()

pcPlot(options?): Viewer

Defined in: src/views/view.ts:590

deprecated: use addViewer(Viewer.pcPlot(options)) Adds a parallel coordinates plot. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/pc-plot

Parameters

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

Returns

Viewer

pieChart()

pieChart(options?): Viewer

Defined in: src/views/view.ts:597

deprecated: use addViewer(Viewer.pieChart(options)) Adds a pie chart. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/pie-chart

Parameters

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

Returns

Viewer

pin()

pin(): void

Defined in: src/views/view.ts:324

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

Returns

void

Inherited from

View.pin

reloadData()

reloadData(options?): Promise<void>

Defined in: src/views/view.ts:684

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>

resetLayout()

resetLayout(): void

Defined in: src/views/view.ts:652

Resets view layout, leaving only grid visible.

Returns

void

saveLayout()

saveLayout(options?): ViewLayout

Defined in: src/views/view.ts:337

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: src/views/view.ts:675

Returns

string

saveStateMap()

saveStateMap(): object | null

Defined in: src/views/view.ts:170

Returns

object | null

Viewer state map. Override in subclasses.

Inherited from

View.saveStateMap

scatterPlot()

scatterPlot(options?): ScatterPlotViewer

Defined in: src/views/view.ts:604

deprecated: use addViewer(Viewer.scatterPlot(options)) 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: src/views/view.ts:611

deprecated: use addViewer(Viewer.scatterPlot3d(options)) 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: src/views/view.ts:167

Parameters

Parameter	Type
`icon`	`HTMLElement`

Returns

void

Inherited from

View.setIcon

setRibbonPanels()

setRibbonPanels(panels, clear?): void

Defined in: src/views/view.ts:156

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: src/views/view.ts:562

deprecated: use addViewer(Viewer.shapeMap(options)) 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: src/widgets/base.ts:317

Returns

void

Inherited from

View.sourceRowsChanged

statistics()

statistics(options?): Viewer

Defined in: src/views/view.ts:618

deprecated: use addViewer(Viewer.statistics(options)) 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: src/widgets/base.ts:277

Registers a subscription to an external event.

Parameters

Parameter	Type	Description
`subscription`	`Subscription`	-

Returns

void

Inherited from

View.sub

tileViewer()

tileViewer(options?): Viewer

Defined in: src/views/view.ts:625

deprecated: use addViewer(Viewer.histogram(options)) Adds a tile viewer. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/tile-viewer

Parameters

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

Returns

Viewer

toDart()

toDart(): any

Defined in: src/widgets/base.ts:269

Returns

any

Inherited from

View.toDart

treeMap()

treeMap(options?): Viewer

Defined in: src/views/view.ts:632

deprecated: use addViewer(Viewer.treeMap(options)) Adds a tree map. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/tree-map

Parameters

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

Returns

Viewer

trellisPlot()

trellisPlot(options?): Viewer

Defined in: src/views/view.ts:639

deprecated: use addViewer(Viewer.trellisPlot(options)) Adds a trellis plot. Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/trellis-plot

Parameters

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

Returns

Viewer

wordCloud()

wordCloud(options?): Viewer

Defined in: src/views/view.ts:647

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

Parameters

Parameter	Type
`options?`	`any`

Returns

Viewer

Deprecated

create()

static create(table, addToWorkspace?): TableView

Defined in: src/views/view.ts:420

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: src/views/view.ts:287

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

Parameters

Parameter	Type
`viewType`	`string`
`options?`	`any`

Returns

View

Inherited from

View.createByType

find()

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

Defined in: src/widgets/base.ts:265

Finds existing widget from its visual root.

Parameters

Parameter	Type
`root`	`Element`

Returns

Widget<any> | null

Inherited from

View.find

forObject()

static forObject(x): View | null

Defined in: src/views/view.ts:265

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: src/views/view.ts:256

Parameters

Parameter	Type
`dart`	`any`

Returns

TableView | View

Inherited from

View.fromDart

fromRoot()

static fromRoot(root): View

Defined in: src/views/view.ts:270

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: src/views/view.ts:291

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: src/widgets/base.ts:260

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

View.getAll

Extends​

Constructors​

Constructor​

Parameters​

Returns​

Constructs​

Overrides​

Properties​

Accessors​

aiDescription​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

basePath​

Get Signature​

Deprecated​

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​

id​

Get Signature​

Extends

Constructors

Constructor

Parameters

Returns

Constructs

Overrides

Properties

Accessors

aiDescription

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

basePath

Get Signature

Deprecated

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

id

Get Signature