Shell

Defined in: js-api/src/shell.ts:40

Grok visual shell, use it to get access to top-level views, tables, methods, etc.

Example

grok.shell.addTableView(grok.data.demo.biosensor(1000));

Constructors

Constructor

new Shell(): Shell

Returns

Shell

Properties

Property	Type	Description	Defined in
build	AppBuildInfo	Build information of the client and the server.	js-api/src/shell.ts:46
settings	Settings & SettingsInterface	User-level platform settings; properties come from SettingsInterface.	js-api/src/shell.ts:44
windows	Windows	Visibility of the shell panels (sidebar, toolbox, console, help, context panel, ...).	js-api/src/shell.ts:42

Accessors

autostartsCompleted

Get Signature

get autostartsCompleted(): Promise<void>

Defined in: js-api/src/shell.ts:128

Resolves once every package autostart function has run; they start 3 seconds after the app has started.

Returns

Promise<void>

---

bottomPanel

Get Signature

get bottomPanel(): HTMLDivElement

Defined in: js-api/src/shell.ts:173

Returns

HTMLDivElement

---

browsePanel

Get Signature

get browsePanel(): BrowsePanel

Defined in: js-api/src/shell.ts:178

The Browse panel (the tree of the platform).

Returns

BrowsePanel

---

canRedo

Get Signature

get canRedo(): boolean

Defined in: js-api/src/shell.ts:384

Whether there is an operation to redo.

Returns

boolean

---

canUndo

Get Signature

get canUndo(): boolean

Defined in: js-api/src/shell.ts:382

Whether there is an operation to undo.

Returns

boolean

---

currentObject

Get Signature

get currentObject(): any

Defined in: js-api/src/shell.ts:141

Current object (rendered in the context panel), or null.

Returns

any

Set Signature

set currentObject(x): void

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

Parameters

Parameter	Type
x	any

Returns

void

---

currentTable

Get Signature

get currentTable(): DataFrame | null

Defined in: js-api/src/shell.ts:70

Current table, or null.

Returns

DataFrame | null

---

currentTableView

Get Signature

get currentTableView(): TableView | null

Defined in: js-api/src/shell.ts:95

Current view when it is a TableView, else null.

Returns

TableView | null

---

currentView

Get Signature

get currentView(): ViewBase | null

Defined in: js-api/src/shell.ts:78

Current view, or null.

Returns

ViewBase | null

Set Signature

set currentView(view): void

Defined in: js-api/src/shell.ts:79

Parameters

Parameter	Type
view	ViewBase | null

Returns

void

---

dockManager

Get Signature

get dockManager(): DockManager

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

Returns

DockManager

---

favorites

Get Signature

get favorites(): Entity[]

Defined in: js-api/src/shell.ts:183

Entities the current user marked as favorites.

Returns

Entity[]

---

lastError

Get Signature

get lastError(): Promise<string | undefined>

Defined in: js-api/src/shell.ts:125

Last error state

Returns

Promise<string | undefined>

Set Signature

set lastError(s): void

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

Parameters

Parameter	Type
s	any

Returns

void

---

o

Get Signature

get o(): any

Defined in: js-api/src/shell.ts:145

Alias of currentObject.

Returns

any

Set Signature

set o(x): void

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

Parameters

Parameter	Type
x	any

Returns

void

---

onRedo

Get Signature

get onRedo(): Observable<UndoRecordArgs>

Defined in: js-api/src/shell.ts:390

Fires after an operation has been redone.

Returns

Observable<UndoRecordArgs>

---

onUndo

Get Signature

get onUndo(): Observable<UndoRecordArgs>

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

Fires after an operation has been undone.

Returns

Observable<UndoRecordArgs>

---

preview

Get Signature

get preview(): ViewBase | null

Defined in: js-api/src/shell.ts:91

The view currently displayed in preview mode.

This allows inspecting an object (like a dataset) temporarily without fully opening it or adding it to the workspace.

Returns

ViewBase | null

Set Signature

set preview(view): void

Defined in: js-api/src/shell.ts:92

Parameters

Parameter	Type
view	ViewBase | null

Returns

void

---

project

Get Signature

get project(): Project

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

Current project

Returns

Project

---

projects

Get Signature

get projects(): Project[]

Defined in: js-api/src/shell.ts:109

Returns the list of currently opened projects

Returns

Project[]

---

sidebar

Get Signature

get sidebar(): TabControl

Defined in: js-api/src/shell.ts:158

Returns

TabControl

---

startUri

Get Signature

get startUri(): string

Defined in: js-api/src/shell.ts:373

The URL the application was opened with.

Returns

string

---

t

Get Signature

get t(): DataFrame

Defined in: js-api/src/shell.ts:73

Alias of currentTable.

Returns

DataFrame

---

tableNames

Get Signature

get tableNames(): string[]

Defined in: js-api/src/shell.ts:326

Names of the currently open tables

Returns

string[]

---

tables

Get Signature

get tables(): DataFrame[]

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

List of currently open tables

Returns

DataFrame[]

---

tableViews

Get Signature

get tableViews(): Iterable<TableView>

Defined in: js-api/src/shell.ts:341

Returns currently open table views

Returns

Iterable<TableView>

---

topMenu

Get Signature

get topMenu(): Menu

Defined in: js-api/src/shell.ts:163

Returns

Menu

---

topPanel

Get Signature

get topPanel(): HTMLDivElement

Defined in: js-api/src/shell.ts:168

Returns

HTMLDivElement

---

tv

Get Signature

get tv(): TableView

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

Alias of currentTableView that assumes the current view is a table view.

Returns

TableView

---

user

Get Signature

get user(): User

Defined in: js-api/src/shell.ts:136

Current user

Returns

User

---

v

Get Signature

get v(): ViewBase

Defined in: js-api/src/shell.ts:82

Alias of currentView.

Returns

ViewBase

Set Signature

set v(view): void

Defined in: js-api/src/shell.ts:83

Parameters

Parameter	Type
view	ViewBase

Returns

void

---

viewer

Get Signature

get viewer(): Viewer

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

Current viewer

Returns

Viewer

Set Signature

set viewer(x): void

Defined in: js-api/src/shell.ts:155

Parameters

Parameter	Type
x	Viewer

Returns

void

---

views

Get Signature

get views(): Iterable<View>

Defined in: js-api/src/shell.ts:336

Returns currently open views

Returns

Iterable<View>

Methods

add()

add(item): Shell

Defined in: js-api/src/shell.ts:225

Adds an item to the workspace. It could be a DataFrame, a View, or an HtmlElement. Throws an error, if the item has a different type.

Parameters

Parameter	Type
item	HTMLElement | DataFrame | ViewBase

Returns

Shell

---

addPreview()

addPreview(v, dockType?, width?, context?): ViewBase

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

Adds a preview for current Browse Panel node.

Parameters

Parameter	Type	Default value
v	ViewBase	undefined
dockType	"fill" | "left" | "right" | "up" | "down"	DOCK_TYPE.FILL
width	number | null	null
context	FuncCall | null	null

Returns

ViewBase

---

addTable()

addTable(table): DataFrame

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

Adds a table to the workspace.

Parameters

Parameter	Type
table	DataFrame

Returns

DataFrame

---

addTablePreview()

addTablePreview(table, dockType?, width?): TableView

Defined in: js-api/src/shell.ts:268

Adds a preview for the specified table.

Parameters

Parameter	Type	Default value
table	DataFrame	undefined
dockType	"fill" | "left" | "right" | "up" | "down" | null	DOCK_TYPE.FILL
width	number | null	null

Returns

TableView

---

addTableView()

addTableView(table, dockType?, width?): TableView

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

Adds a view for the specified table.

Parameters

Parameter	Type	Default value
table	DataFrame	undefined
dockType	"fill" | "left" | "right" | "up" | "down" | null	DOCK_TYPE.FILL
width	number | null	null

Returns

TableView

---

addView()

addView(v, dockType?, width?, context?): ViewBase

Defined in: js-api/src/shell.ts:238

Adds a view.

Parameters

Parameter	Type	Default value
v	ViewBase	undefined
dockType	"fill" | "left" | "right" | "up" | "down"	DOCK_TYPE.FILL
width	number | null	null
context	FuncCall | null	null

Returns

ViewBase

---

clearDirtyFlag()

clearDirtyFlag(): void

Defined in: js-api/src/shell.ts:368

Clears dirty flag in scratchpad and open projects.

Returns

void

---

clearLastError()

clearLastError(): void

Defined in: js-api/src/shell.ts:133

Clears lastError.

Returns

void

---

closeAll()

closeAll(): void

Defined in: js-api/src/shell.ts:290

Closes everything (views, tables, projects) and returns the platform to the initial state.

Returns

void

---

closeTable()

closeTable(table): void

Defined in: js-api/src/shell.ts:120

Closes a table and removes from the workspace.

Parameters

Parameter	Type
table	DataFrame

Returns

void

---

dockElement()

dockElement(element, title?, dockStyle?, ratio?): void

Defined in: js-api/src/shell.ts:212

Docks element in a separate window. Sample: https://public.datagrok.ai/js/samples/ui/docking/docking

Parameters

Parameter	Type	Default value	Description
element	HTMLElement	undefined	-
title	string | null	null	-
dockStyle	"fill" | "left" | "right" | "up" | "down"	DOCK_TYPE.FILL	-
ratio	number	0.5	area to take (relative to parent)

Returns

void

---

error()

error(s, options?): void

Defined in: js-api/src/shell.ts:198

Shows information message (red background)

Parameters

Parameter	Type	Description
s	string | HTMLElement	message
options?	BalloonOptions	-

Returns

void

---

getTableView()

getTableView(tableName): TableView

Defined in: js-api/src/shell.ts:280

Parameters

Parameter	Type
tableName	string

Returns

TableView

Deprecated

Use tableView. Removed in 1.30. Returns TableView for the specified table if it exists, opens a new view if necessary. Search is case-insensitive.

---

getVar()

getVar(variableName): object

Defined in: js-api/src/shell.ts:352

Returns the value of the specified variable. Search is case-insensitive.

Parameters

Parameter	Type
variableName	string

Returns

object

---

info()

info(x, options?): void

Defined in: js-api/src/shell.ts:190

Shows information message (green background)

Parameters

Parameter	Type	Description
x	any	message
options?	BalloonOptions	-

Returns

void

---

newView()

newView(name?, children?, options?): View

Defined in: js-api/src/shell.ts:257

Adds a new view with the specified name.

Parameters

Parameter	Type	Default value	Description
name	string	'view'	view name
children?	object[]	undefined	content to be added by calling ui.appendAll
options?	string | { } | null	undefined	-

Returns

View

---

openFileOpenDialog()

openFileOpenDialog(): void

Defined in: js-api/src/shell.ts:285

Opens a dialog for opening a file with tabular data (CSV, XSLS, etc)

Returns

void

---

redo()

redo(): void

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

Re-applies the last undone operation (Ctrl+Shift+Z, Ctrl+Y).

Returns

void

---

registerViewer()

registerViewer(viewerTypeName, description, createViewer): void

Defined in: js-api/src/shell.ts:305

Registers a viewer. Sample: https://public.datagrok.ai/js/samples/functions/custom-viewers/viewers

Parameters

Parameter	Type	Description
viewerTypeName	string	-
description	string	-
createViewer	(...params) => JsViewer	a function that returns JsViewer

Returns

void

---

reportTest()

reportTest(type, params): Promise<void>

Defined in: js-api/src/shell.ts:54

Internal

Parameters

Parameter	Type
type	string
params	object

Returns

Promise<void>

---

route()

route(url): View

Defined in: js-api/src/shell.ts:218

Opens the view that handles the specified url. Sample: https://public.datagrok.ai/js/samples/ui/docking/docking

Parameters

Parameter	Type
url	string

Returns

View

---

setCurrentObject()

setCurrentObject(x, freeze, force?): void

Defined in: js-api/src/shell.ts:149

Sets the current object; [freeze] keeps the context panel from following further changes, [force] re-sets the same object.

Parameters

Parameter	Type
x	any
freeze	boolean
force?	boolean

Returns

void

---

setVar()

setVar(variableName, variableValue): object

Defined in: js-api/src/shell.ts:357

Sets the value of the specified variable, and returns this value.

Parameters

Parameter	Type
variableName	string
variableValue	object

Returns

object

---

table()

table(tableName): DataFrame

Defined in: js-api/src/shell.ts:310

Returns a DataFrame with the specified [tableName].

Parameters

Parameter	Type
tableName	string

Returns

DataFrame

---

tableByName()

tableByName(tableName): DataFrame

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

Parameters

Parameter	Type
tableName	string

Returns

DataFrame

Deprecated

Use table. Removed in 1.30. Returns a table by its name. Search is case-insensitive.

---

tableView()

tableView(tableName): TableView

Defined in: js-api/src/shell.ts:321

Returns a first TableView for the specified [tableName], or null if there are no such views.

Parameters

Parameter	Type
tableName	string

Returns

TableView

---

testError()

testError(s): void

Defined in: js-api/src/shell.ts:49

Internal

Parameters

Parameter	Type
s	string

Returns

void

---

undo()

undo(): void

Defined in: js-api/src/shell.ts:376

Reverses the last operation recorded for the active table or view (Ctrl+Z).

Returns

void

---

view()

view(name): View | null

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

Returns a view with the specified [name], or null if there is no such view.

Parameters

Parameter	Type
name	string

Returns

View | null

---

warning()

warning(s, options?): void

Defined in: js-api/src/shell.ts:205

Shows warning message (yellow background)

Parameters

Parameter	Type	Description
s	string | HTMLElement	message
options?	BalloonOptions	-

Returns

void