TableView

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

new TableView()

new TableView(dart): TableView

Parameters

Parameter	Type
`dart`	`any`

Returns

TableView

Overrides

View . constructor

Constructs

TableView

Source

src/views/view.ts:379

Properties

Property	Modifier	Type	Default value	Description	Inherited from
`_name`	`protected`	`string`	`'New View'`	-	`View`.`_name`
`_root`	`protected`	`HTMLElement`	`undefined`	-	`View`.`_root`
`dart`	`public`	`any`	`undefined`	-	`View`.`dart`
`subs`	`public`	`Subscription`[]	`undefined`	-	`View`.`subs`
`temp`	`public`	`any`	`undefined`	Contains auxiliary information	`View`.`temp`
`ALL_VIEW_TYPES`	`readonly`	`string`[]	`...`	-	`View`.`ALL_VIEW_TYPES`
`APPS`	`readonly`	`"apps"`	`'apps'`	-	`View`.`APPS`
`BROWSE`	`readonly`	`"browse"`	`'browse'`	-	`View`.`BROWSE`
`DATABASES`	`readonly`	`"databases"`	`'databases'`	-	`View`.`DATABASES`
`DATA_CONNECTIONS`	`readonly`	`"connections"`	`'connections'`	-	`View`.`DATA_CONNECTIONS`
`DATA_JOB_RUNS`	`readonly`	`"jobs"`	`'jobs'`	-	`View`.`DATA_JOB_RUNS`
`DATA_QUERY_RUNS`	`readonly`	`"queryruns"`	`'queryruns'`	-	`View`.`DATA_QUERY_RUNS`
`EMAILS`	`readonly`	`"emails"`	`'emails'`	-	`View`.`EMAILS`
`FILES`	`readonly`	`"files"`	`'files'`	-	`View`.`FILES`
`FORUM`	`readonly`	`"forum"`	`'forum'`	-	`View`.`FORUM`
`FUNCTIONS`	`readonly`	`"functions"`	`'functions'`	-	`View`.`FUNCTIONS`
`GROUPS`	`readonly`	`"groups"`	`'groups'`	-	`View`.`GROUPS`
`HELP`	`readonly`	`"help"`	`'help'`	-	`View`.`HELP`
`JS_EDITOR`	`readonly`	`"js"`	`'js'`	-	`View`.`JS_EDITOR`
`MODELS`	`readonly`	`"models"`	`'models'`	-	`View`.`MODELS`
`NOTEBOOKS`	`readonly`	`"notebooks"`	`'notebooks'`	-	`View`.`NOTEBOOKS`
`OPEN_TEXT`	`readonly`	`"text"`	`'text'`	-	`View`.`OPEN_TEXT`
`PACKAGES`	`readonly`	`"packages"`	`'packages'`	-	`View`.`PACKAGES`
`PACKAGE_REPOSITORIES`	`readonly`	`"repositories"`	`'repositories'`	-	`View`.`PACKAGE_REPOSITORIES`
`PROJECTS`	`readonly`	`"projects"`	`'projects'`	-	`View`.`PROJECTS`
`QUERIES`	`readonly`	`"queries"`	`'queries'`	-	`View`.`QUERIES`
`SCRIPT`	`readonly`	`"script"`	`'script'`	-	`View`.`SCRIPT`
`SCRIPTS`	`readonly`	`"scripts"`	`'scripts'`	-	`View`.`SCRIPTS`
`SETTINGS`	`readonly`	`"settings"`	`'settings'`	-	`View`.`SETTINGS`
`SKETCH`	`readonly`	`"sketch"`	`'sketch'`	-	`View`.`SKETCH`
`USERS`	`readonly`	`"users"`	`'users'`	-	`View`.`USERS`
`VIEW_LAYOUTS`	`readonly`	`"layouts"`	`'layouts'`	-	`View`.`VIEW_LAYOUTS`
`WEB_SERVICES`	`readonly`	`"webservices"`	`'webservices'`	-	`View`.`WEB_SERVICES`
`WELCOME`	`readonly`	`"welcome"`	`'welcome'`	-	`View`.`WELCOME`

Accessors

basePath

get basePath(): string

Deprecated

use path instead

set basePath(s): void

Parameters

Parameter	Type
`s`	`string`

Returns

string

Source

src/views/view.ts:131

box

get box(): boolean

set box(b): void

Parameters

Parameter	Type
`b`	`boolean`

Returns

boolean

Source

src/views/view.ts:77

closing

get closing(): boolean

Whether the view is currently closing.

set closing(c): void

Parameters

Parameter	Type
`c`	`boolean`

Returns

boolean

Source

src/views/view.ts:149

dataFrame

get dataFrame(): DataFrame

set dataFrame(x): void

Parameters

Parameter	Type
`x`	`DataFrame`

Returns

DataFrame

Source

src/views/view.ts:399

description

get description(): string

set description(s): void

Parameters

Parameter	Type
`s`	`string`

Returns

string

Source

src/views/view.ts:273

dockManager

get dockManager(): DockManager

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

Returns

DockManager

Source

src/views/view.ts:430

dockNode

get dockNode(): DockNode

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

Source

src/views/view.ts:423

entity

get entity(): null | object

set entity(_e): void

Parameters

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

Returns

null | object

Source

src/views/view.ts:127

grid

get grid(): Grid

Associated grid (spreadsheet).

Returns

Grid

Source

src/views/view.ts:392

helpUrl

get helpUrl(): null | string

set helpUrl(url): void

Parameters

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

Returns

null | string

View help URL.

Source

src/views/view.ts:282

id

get id(): string

Returns

string

Source

src/views/view.ts:269

name

get name(): string

View name. It gets shown in the tab handle.

set name(s): void

Parameters

Parameter	Type
`s`	`string`

Returns

string

Source

src/views/view.ts:315

parentCall

get parentCall(): undefined | FuncCall

set parentCall(s): void

Parameters

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

Returns

undefined | FuncCall

Source

src/views/view.ts:118

parentView

get parentView(): ViewBase

set parentView(s): void

Parameters

Parameter	Type
`s`	`ViewBase`

Returns

ViewBase

Source

src/views/view.ts:121

path

get path(): string

View URI, relative to the view root

set path(s): void

Parameters

Parameter	Type
`s`	`string`

Returns

string

Source

src/views/view.ts:174

ribbonMenu

get ribbonMenu(): Menu

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

set ribbonMenu(menu): void

Parameters

Parameter	Type
`menu`	`Menu`

Returns

Menu

Source

src/views/view.ts:141

root

get root(): HTMLElement

Returns

HTMLElement

Source

src/views/view.ts:261

statusBarPanels

get statusBarPanels(): HTMLDivElement[]

Status bar panels to be shown on the bottom

set statusBarPanels(panels): void

Parameters

Parameter	Type
`panels`	`HTMLDivElement`[]

Returns

HTMLDivElement[]

Source

src/views/view.ts:145

syncCurrentObject

get syncCurrentObject(): boolean

set syncCurrentObject(x): void

Parameters

Parameter	Type
`x`	`boolean`

Returns

boolean

Source

src/views/view.ts:620

table

get table(): null | DataFrame

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

Returns

null | DataFrame

Source

src/views/view.ts:389

toolbox

get toolbox(): HTMLElement

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

set toolbox(x): void

Parameters

Parameter	Type
`x`	`HTMLElement`

Returns

HTMLElement

Source

src/views/view.ts:136

toolboxPage

get toolboxPage(): ToolboxPage

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

Returns

ToolboxPage

Source

src/views/view.ts:403

type

get type(): string

View type

Returns

string

Source

src/views/view.ts:265

viewers

get viewers(): Iterable <Viewer<any>>

Returns all viewers.

Returns

Iterable <Viewer<any>>

Source

src/views/view.ts:616

Methods

_onAdded()

_onAdded(): void

Returns

void

Inherited from

View . _onAdded

Source

src/views/view.ts:328

acceptsPath()

acceptsPath(_urlPath): boolean

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

Source

src/views/view.ts:182

addViewer()

addViewer(v, options?): Viewer<any>

Adds a viewer of the specified type.

Parameters

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

Returns

Viewer<any>

Source

src/views/view.ts:408

append()

append(item): HTMLElement

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

Parameters

Parameter	Type	Description
`item`	`any`

Returns

HTMLElement

Inherited from

View . append

Source

src/views/view.ts:187

appendAll()

appendAll(items): HTMLElement

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

Parameters

Parameter	Type	Description
`items`	`HTMLElement`[]

Returns

HTMLElement

Inherited from

View . appendAll

Source

src/views/view.ts:194

barChart()

barChart(options?): Viewer<any>

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<any>

Source

src/views/view.ts:445

boxPlot()

boxPlot(options?): Viewer<any>

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<any>

Source

src/views/view.ts:452

calendar()

calendar(options?): Viewer<any>

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<any>

Source

src/views/view.ts:461

close()

close(): void

Closes this view.

Returns

void

Inherited from

View . close

Source

src/views/view.ts:204

corrPlot()

corrPlot(options?): Viewer<any>

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<any>

Source

src/views/view.ts:468

densityPlot()

densityPlot(options?): Viewer<any>

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<any>

Source

src/views/view.ts:475

detach()

detach(): void

Detaches and closes the view.

Returns

void

Overrides

View . detach

Source

src/views/view.ts:605

detachViewers()

detachViewers(): void

Detaches all viewers.

Returns

void

Source

src/views/view.ts:610

filters()

filters(options?): Viewer<any>

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<any>

Source

src/views/view.ts:482

form()

form(options?): Viewer<any>

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<any>

Source

src/views/view.ts:489

getFiltersGroup()

getFiltersGroup(options?): FilterGroup

Returns existing, or creates a new filter group.

Parameters

Parameter	Type
`options`?	`object`
`options.createDefaultFilters`?	`boolean`

Returns

FilterGroup

Source

src/views/view.ts:395

getIcon()

getIcon(): null | HTMLElement

Returns

null | HTMLElement

View icon. Override in subclasses.

Inherited from

View . getIcon

Source

src/views/view.ts:165

getInfo()

getInfo(): ViewLayout

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

getRibbonPanels()

getRibbonPanels(): HTMLElement[][]

Returns

HTMLElement[][]

Inherited from

View . getRibbonPanels

Source

src/views/view.ts:160

handlePath()

handlePath(_urlPath): void

Handles URL path. Override in subclasses.

Parameters

Parameter	Type
`_urlPath`	`string`

Returns

void

Inherited from

View . handlePath

Source

src/views/view.ts:178

heatMap()

heatMap(options?): Viewer<any>

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<any>

Source

src/views/view.ts:496

histogram()

histogram(options?): Viewer<any>

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<any>

Source

src/views/view.ts:438

lineChart()

lineChart(options?): Viewer<any>

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<any>

Source

src/views/view.ts:503

loadLayout()

loadLayout(layout, pickupColumnTags?): void

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

Source

src/views/view.ts:293

loadState()

loadState(x, options?): void

Parameters

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

Returns

void

Source

src/views/view.ts:627

loadStateMap()

loadStateMap(_stateMap): void

Loads view state map. Override in subclasses.

Parameters

Parameter	Type
`_stateMap`	`object`

Returns

void

Inherited from

View . loadStateMap

Source

src/views/view.ts:171

markup()

markup(options?): Viewer<any>

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<any>

Source

src/views/view.ts:517

matrixPlot()

matrixPlot(options?): Viewer<any>

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<any>

Source

src/views/view.ts:524

networkDiagram()

networkDiagram(options?): Viewer<any>

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<any>

Source

src/views/view.ts:531

pcPlot()

pcPlot(options?): Viewer<any>

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<any>

Source

src/views/view.ts:538

pieChart()

pieChart(options?): Viewer<any>

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<any>

Source

src/views/view.ts:545

resetLayout()

resetLayout(): void

Resets view layout, leaving only grid visible.

Returns

void

Source

src/views/view.ts:600

saveLayout()

saveLayout(): ViewLayout

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

Returns

ViewLayout

Inherited from

View . saveLayout

Source

src/views/view.ts:301

saveState()

saveState(): string

Returns

string

Source

src/views/view.ts:623

saveStateMap()

saveStateMap(): null | object

Returns

null | object

Viewer state map. Override in subclasses.

Inherited from

View . saveStateMap

Source

src/views/view.ts:168

scatterPlot()

scatterPlot(options?): ScatterPlotViewer

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

Source

src/views/view.ts:552

scatterPlot3d()

scatterPlot3d(options?): Viewer<any>

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<any>

Source

src/views/view.ts:559

setRibbonPanels()

setRibbonPanels(panels, clear): void

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

Source

src/views/view.ts:156

shapeMap()

shapeMap(options?): Viewer<any>

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<any>

Source

src/views/view.ts:510

statistics()

statistics(options?): Viewer<any>

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<any>

Source

src/views/view.ts:566

tileViewer()

tileViewer(options?): Viewer<any>

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<any>

Source

src/views/view.ts:573

treeMap()

treeMap(options?): Viewer<any>

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<any>

Source

src/views/view.ts:580

trellisPlot()

trellisPlot(options?): Viewer<any>

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<any>

Source

src/views/view.ts:587

wordCloud()

wordCloud(options?): Viewer<any>

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

Parameters

Parameter	Type
`options`?	`any`

Returns

Viewer<any>

Deprecated

Source

src/views/view.ts:595

create()

static create(table, addToWorkspace): TableView

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

Source

src/views/view.ts:384

createByType()

static createByType(viewType, options?): View

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

Source

src/views/view.ts:257

forObject()

static forObject(x): null | View

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

Parameters

Parameter	Type
`x`	`any`

Returns

null | View

Inherited from

View . forObject

Source

src/views/view.ts:236

fromDart()

static fromDart(dart): View | TableView

Parameters

Parameter	Type
`dart`	`any`

Returns

View | TableView

Inherited from

View . fromDart

Source

src/views/view.ts:227

fromRoot()

static fromRoot(root): View

Parameters

Parameter	Type
`root`	`HTMLElement`

Returns

View

Inherited from

View . fromRoot

Source

src/views/view.ts:240

TableView

Extends​

Constructors​

new TableView()​

Parameters​

Returns​

Overrides​

Constructs​

Source​

Properties​

Accessors​

basePath​

Deprecated​

Parameters​

Returns​

Source​

box​

Parameters​

Returns​

Source​

closing​

Parameters​

Returns​

Source​

dataFrame​

Parameters​

Returns​

Source​

description​

Parameters​

Returns​

Source​

dockManager​

Returns​

Source​

dockNode​

Returns​

Source​

entity​

Parameters​

Returns​

Source​

grid​

Returns​

Source​

helpUrl​

Parameters​

Returns​

Source​

id​

Returns​

Source​

name​

Parameters​

Returns​

Source​

parentCall​

Parameters​

Returns​

Source​

parentView​

Parameters​

Returns​

Source​

path​

Parameters​

Returns​

Source​

ribbonMenu​

Parameters​

Returns​

Source​

root​

Returns​

Source​

statusBarPanels​

Parameters​

Returns​

Source​

syncCurrentObject​

Extends

Constructors

new TableView()

Parameters

Returns

Overrides

Constructs

Source

Properties

Accessors

basePath

Deprecated

Parameters

Returns

Source

box

Parameters

Returns

Source

closing

Parameters

Returns

Source

dataFrame

Parameters

Returns

Source

description

Parameters

Returns

Source

dockManager

Returns

Source

dockNode

Returns

Source

entity

Parameters

Returns

Source

grid

Returns

Source

helpUrl

Parameters

Returns

Source

id

Returns

Source

name

Parameters

Returns

Source

parentCall

Parameters

Returns

Source

parentView

Parameters

Returns

Source

path

Parameters

Returns

Source

ribbonMenu

Parameters

Returns

Source

root

Returns

Source

statusBarPanels

Parameters

Returns

Source

syncCurrentObject

Parameters