Class: Shell

dg.Shell

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()

Defined in

src/shell.ts:24

Properties

settings

• settings: Settings

Defined in

src/shell.ts:22

---

windows

• windows: Windows

Defined in

src/shell.ts:21

Accessors

bottomPanel

• get bottomPanel(): HTMLDivElement

Returns

HTMLDivElement

Defined in

src/shell.ts:105

---

dockManager

• get dockManager(): DockManager

Returns

DockManager

Defined in

src/shell.ts:292

---

lastError

• get lastError(): string

Last error state

Returns

string

Defined in

src/shell.ts:66

• set lastError(s): void

Parameters

Name	Type
s	string

Returns

void

Defined in

src/shell.ts:70

---

o

• get o(): any

Current object (rendered in the context panel)

Returns

any

Defined in

src/shell.ts:81

• set o(x): void

Parameters

Name	Type
x	any

Returns

void

Defined in

src/shell.ts:85

---

project

• get project(): Project

Current project

Returns

Project

Defined in

src/shell.ts:49

---

sidebar

• get sidebar(): TabControl

Returns

TabControl

Defined in

src/shell.ts:90

---

startUri

• get startUri(): string

Returns

string

Defined in

src/shell.ts:301

---

t

• get t(): DataFrame

Current table, or null.

Returns

DataFrame

Defined in

src/shell.ts:36

---

tableNames

• get tableNames(): string[]

Names of the currently open tables

Returns

string[]

Defined in

src/shell.ts:248

---

tableViews

• get tableViews(): Iterable<TableView>

Returns currently open table views

Returns

Iterable<TableView>

Defined in

src/shell.ts:264

---

tables

• get tables(): DataFrame[]

List of currently open tables

Returns

DataFrame[]

Defined in

src/shell.ts:254

---

topMenu

• get topMenu(): Menu

Returns

Menu

Defined in

src/shell.ts:95

---

topPanel

• get topPanel(): HTMLDivElement

Returns

HTMLDivElement

Defined in

src/shell.ts:100

---

tv

• get tv(): TableView

Current table view, or null

Returns

TableView

Defined in

src/shell.ts:45

---

user

• get user(): User

Current user

Returns

User

Defined in

src/shell.ts:76

---

v

• get v(): ViewBase

Current view

Returns

ViewBase

Defined in

src/shell.ts:41

• set v(view): void

Parameters

Name	Type
view	ViewBase

Returns

void

Defined in

src/shell.ts:42

---

views

• get views(): Iterable<View>

Returns currently open views

Returns

Iterable<View>

Defined in

src/shell.ts:259

Methods

add

▸ add(item): Shell

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

Name	Type
item	HTMLElement | DataFrame | ViewBase

Returns

Shell

Defined in

src/shell.ts:146

---

addTable

▸ addTable(table): void

Adds a table to the workspace.

Parameters

Name	Type
table	DataFrame

Returns

void

Defined in

src/shell.ts:55

---

addTableView

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

Adds a view for the specified table.

Parameters

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

Returns

TableView

Defined in

src/shell.ts:194

---

addView

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

Adds a view.

Parameters

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

Returns

ViewBase

Defined in

src/shell.ts:159

---

clearDirtyFlag

▸ clearDirtyFlag(): void

Clears dirty flag in scratchpad and open projects.

Returns

void

Defined in

src/shell.ts:297

---

closeAll

▸ closeAll(): void

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

Returns

void

Defined in

src/shell.ts:209

---

closeTable

▸ closeTable(table): void

Closes a table and removes from the workspace.

Parameters

Name	Type
table	DataFrame

Returns

void

Defined in

src/shell.ts:61

---

dockElement

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

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

Parameters

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

Returns

void

Defined in

src/shell.ts:133

---

error

▸ error(s): void

Shows information message (red background)

Parameters

Name	Type	Description
s	string | HTMLElement	message

Returns

void

Defined in

src/shell.ts:117

---

getTableView

▸ getTableView(tableName): TableView

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

Parameters

Name	Type
tableName	string

Returns

TableView

Defined in

src/shell.ts:204

---

getVar

▸ getVar(variableName): object

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

Parameters

Name	Type
variableName	string

Returns

object

Defined in

src/shell.ts:279

---

info

▸ info(x): void

Shows information message (green background)

Parameters

Name	Type	Description
x	any	message

Returns

void

Defined in

src/shell.ts:111

---

newView

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

Adds a new view with the specified name.

Parameters

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

Returns

View

Defined in

src/shell.ts:179

---

registerView

▸ registerView(viewTypeName, createView, viewUrlPath?): void

Registers a view.

Parameters

Name	Type	Default value	Description
viewTypeName	string	undefined
createView	(...params: any[]) => ViewBase	undefined	a function that returns ViewBase
viewUrlPath	string	''

Returns

void

Defined in

src/shell.ts:217

---

registerViewer

▸ registerViewer(viewerTypeName, description, createViewer): void

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

Parameters

Name	Type	Description
viewerTypeName	string
description	string
createViewer	(...params: any[]) => JsViewer	a function that returns JsViewer

Returns

void

Defined in

src/shell.ts:226

---

route

▸ route(url): View

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

Parameters

Name	Type
url	string

Returns

View

Defined in

src/shell.ts:139

---

setVar

▸ setVar(variableName, variableValue): object

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

Parameters

Name	Type
variableName	string
variableValue	object

Returns

object

Defined in

src/shell.ts:286

---

table

▸ table(tableName): DataFrame

Returns a DataFrame with the specified [tableName].

Parameters

Name	Type
tableName	string

Returns

DataFrame

Defined in

src/shell.ts:231

---

tableByName

▸ tableByName(tableName): DataFrame

Returns a table by its name. Search is case-insensitive.

Parameters

Name	Type
tableName	string

Returns

DataFrame

Defined in

src/shell.ts:272

---

tableView

▸ tableView(tableName): TableView

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

Parameters

Name	Type
tableName	string

Returns

TableView

Defined in

src/shell.ts:242

---

view

▸ view(name): null | View

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

Parameters

Name	Type
name	string

Returns

null | View

Defined in

src/shell.ts:236

---

warning

▸ warning(s): void

Shows warning message (yellow background)

Parameters

Name	Type	Description
s	string | HTMLElement	message

Returns

void

Defined in

src/shell.ts:123