DockView

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

A view is typically docked in the main document area of the Grok platform. See [TableView], [SketchView], etc

Extends

• View

Constructors

Constructor

new DockView(dart): DockView

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

Parameters

Parameter	Type
dart	any

Returns

DockView

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:234
ALL_VIEW_TYPES	readonly	string[]	undefined	-	View.ALL_VIEW_TYPES	src/views/view.ts:406
APPS	readonly	"apps"	'apps'	-	View.APPS	src/views/view.ts:376
BROWSE	readonly	"browse"	'browse'	-	View.BROWSE	src/views/view.ts:403
DATA_CONNECTIONS	readonly	"connections"	'connections'	-	View.DATA_CONNECTIONS	src/views/view.ts:390
DATA_JOB_RUNS	readonly	"jobs"	'jobs'	-	View.DATA_JOB_RUNS	src/views/view.ts:391
DATA_QUERY_RUNS	readonly	"queryruns"	'queryruns'	-	View.DATA_QUERY_RUNS	src/views/view.ts:393
DATABASES	readonly	"databases"	'databases'	-	View.DATABASES	src/views/view.ts:386
DOCKERS	readonly	"dockers"	'dockers'	-	View.DOCKERS	src/views/view.ts:404
EMAILS	readonly	"emails"	'emails'	-	View.EMAILS	src/views/view.ts:394
FILES	readonly	"files"	'files'	-	View.FILES	src/views/view.ts:392
FORUM	readonly	"forum"	'forum'	-	View.FORUM	src/views/view.ts:381
FUNCTIONS	readonly	"functions"	'functions'	-	View.FUNCTIONS	src/views/view.ts:389
GROUPS	readonly	"groups"	'groups'	-	View.GROUPS	src/views/view.ts:395
HELP	readonly	"help"	'help'	-	View.HELP	src/views/view.ts:384
JS_EDITOR	readonly	"js"	'js'	-	View.JS_EDITOR	src/views/view.ts:402
MODELS	readonly	"models"	'models'	-	View.MODELS	src/views/view.ts:396
NOTEBOOKS	readonly	"notebooks"	'notebooks'	-	View.NOTEBOOKS	src/views/view.ts:383
OPEN_TEXT	readonly	"text"	'text'	-	View.OPEN_TEXT	src/views/view.ts:385
PACKAGE_REPOSITORIES	readonly	"repositories"	'repositories'	-	View.PACKAGE_REPOSITORIES	src/views/view.ts:401
PACKAGES	readonly	"packages"	'packages'	-	View.PACKAGES	src/views/view.ts:400
PROJECTS	readonly	"projects"	'projects'	-	View.PROJECTS	src/views/view.ts:382
QUERIES	readonly	"queries"	'queries'	-	View.QUERIES	src/views/view.ts:397
SCRIPT	readonly	"script"	'script'	-	View.SCRIPT	src/views/view.ts:379
SCRIPTS	readonly	"scripts"	'scripts'	-	View.SCRIPTS	src/views/view.ts:398
SETTINGS	readonly	"settings"	'settings'	-	View.SETTINGS	src/views/view.ts:377
SKETCH	readonly	"sketch"	'sketch'	-	View.SKETCH	src/views/view.ts:380
USERS	readonly	"users"	'users'	-	View.USERS	src/views/view.ts:399
VIEW_LAYOUTS	readonly	"layouts"	'layouts'	-	View.VIEW_LAYOUTS	src/views/view.ts:388
WEB_SERVICES	readonly	"webservices"	'webservices'	-	View.WEB_SERVICES	src/views/view.ts:387
WELCOME	readonly	"welcome"	'welcome'	-	View.WELCOME	src/views/view.ts:378

Accessors

aiDescription

Get Signature

get aiDescription(): string | null

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

AI briefing of the underlying view. 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:250

A short AI-facing briefing: what this view 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:320

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

---

description

Get Signature

get description(): string

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

View description. Used in UI and AI.

Returns

string

Set Signature

set description(s): void

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

Parameters

Parameter	Type
s	string

Returns

void

Inherited from

View.description

---

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

---

helpUrl

Get Signature

get helpUrl(): string | null

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

Returns

string | null

View help URL.

Set Signature

set helpUrl(url): void

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

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:315

Returns

string

Inherited from

View.id

---

isPinned

Get Signature

get isPinned(): boolean

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

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:329

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

View.isPinned

---

jsView

Get Signature

get jsView(): ViewBase | null

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

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:358

View name. It gets shown in the tab handle.

Returns

string

Set Signature

set name(s): void

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

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:317

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:307

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

---

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

---

type

Get Signature

get type(): string

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

View type

Returns

string

Inherited from

View.type

Methods

_handleResize()

_handleResize(): string

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

Returns

string

---

_onAdded()

_onAdded(): void

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

Returns

void

Inherited from

View._onAdded

---

acceptsPath()

acceptsPath(_urlPath): boolean

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

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

---

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:203

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:210

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

---

close()

close(): void

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

Closes this view.

Returns

void

Inherited from

View.close

---

detach()

detach(): void

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

Detaches this view.

Returns

void

Inherited from

View.detach

---

getDartProperties()

getDartProperties(): any[]

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

Returns

any[]

Inherited from

View.getDartProperties

---

getFunctions()

getFunctions(): Func[]

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

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:352

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:303

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

---

getWidgetStatus()

getWidgetStatus(): IWidgetStatus

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

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:194

Handles URL path. Override in subclasses.

Parameters

Parameter	Type
_urlPath	string

Returns

void

Inherited from

View.handlePath

---

initDock()

initDock(): string

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

Returns

string

---

loadLayout()

loadLayout(layout, pickupColumnTags?): void

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

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

---

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

---

onEvent()

onEvent(eventId?): Observable<any>

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

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:311

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Inherited from

View.onFrameAttached

---

onPropertyChanged()

onPropertyChanged(property): void

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

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

---

pin()

pin(): void

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

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

Returns

void

Inherited from

View.pin

---

saveLayout()

saveLayout(options?): ViewLayout

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

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

---

saveStateMap()

saveStateMap(): object | null

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

Returns

object | null

Viewer state map. Override in subclasses.

Inherited from

View.saveStateMap

---

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

---

sourceRowsChanged()

sourceRowsChanged(): void

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

Returns

void

Inherited from

View.sourceRowsChanged

---

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

---

toDart()

toDart(): any

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

Returns

any

Inherited from

View.toDart

---

create()

static create(options?): View

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

Creates a new empty view.

Parameters

Parameter	Type	Description
options?	string | { } | null	-

Returns

View

Inherited from

View.create

---

createByType()

static createByType(viewType, options?): View

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

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:273

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:264

Parameters

Parameter	Type
dart	any

Returns

TableView | View

Inherited from

View.fromDart

---

fromRoot()

static fromRoot(root): View

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

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:299

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