DockView

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

Extends

• View

Constructors

new DockView()

new DockView(dart): DockView

Parameters

Parameter	Type
dart	any

Returns

DockView

Overrides

View . constructor

Source

src/views/view.ts:668

Properties

Property	Modifier	Type	Default value	Description	Inherited from
_functions	protected	Func[]	[]	-	View._functions
_name	protected	string	'New View'	-	View._name
_properties	protected	Property[]	[]	-	View._properties
_root	protected	HTMLElement	undefined	-	View._root
dart	public	any	undefined	-	View.dart
factory	public	null | Func	null	Constructor function. No parameters, returns [Widget].	View.factory
isDetached	public	boolean	false	-	View.isDetached
props	public	any	undefined	-	View.props
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
DOCKERS	readonly	"dockers"	'dockers'	-	View.DOCKERS
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:126

---

box

get box(): boolean

set box(b): void

Parameters

Parameter	Type
b	boolean

Returns

boolean

Source

src/views/view.ts:74

---

children

get children(): Widget<any>[]

Parent widget up the DOM tree, or null.

Returns

Widget<any>[]

Source

src/widgets.ts:293

---

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

---

description

get description(): string

View description. Used in UI and AI.

set description(s): void

Parameters

Parameter	Type
s	string

Returns

string

Source

src/views/view.ts:280

---

entity

get entity(): null | object

set entity(_e): void

Parameters

Parameter	Type
_e	null | object

Returns

null | object

Source

src/views/view.ts:122

---

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

---

id

get id(): string

Returns

string

Source

src/views/view.ts:275

---

isPinned

get isPinned(): boolean

Returns

boolean

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

Source

src/views/view.ts:288

---

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

---

parent

get parent(): null | Widget<any>

Parent widget up the DOM tree, or null.

Returns

null | Widget<any>

Source

src/widgets.ts:290

---

parentCall

get parentCall(): undefined | FuncCall

set parentCall(s): void

Parameters

Parameter	Type
s	undefined | FuncCall

Returns

undefined | FuncCall

Source

src/views/view.ts:113

---

parentView

get parentView(): ViewBase

set parentView(s): void

Parameters

Parameter	Type
s	ViewBase

Returns

ViewBase

Source

src/views/view.ts:116

---

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

---

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

---

root

get root(): HTMLElement

Returns the content (visual root) of this view.

Returns

HTMLElement

Source

src/views/view.ts:267

---

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

---

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

---

type

get type(): string

View type

Returns

string

Source

src/views/view.ts:271

Methods

_handleResize()

_handleResize(): string

Returns

string

Source

src/views/view.ts:676

---

_onAdded()

_onAdded(): void

Returns

void

Inherited from

View . _onAdded

Source

src/views/view.ts:332

---

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

---

addProperty()

private addProperty(propertyName, propertyType, defaultValue, options): any

Registers an property with the specified type, name, and defaultValue.

Parameters

Parameter	Type	Default value	Description
propertyName	string	undefined
propertyType	"string" | "bigint" | "object" | "map" | "file" | "view" | "blob" | "int" | "double" | "bool" | "byte_array" | "datetime" | "qnum" | "dataframe" | "num" | "string_list" | "dataframe_list" | "cell" | "column" | "column_list" | "graphics" | "tablerowfiltercall" | "colfiltercall" | "bitset" | "dynamic" | "viewer" | "list" | "semantic_value" | "func" | "funccall" | "property" | "categorical" | "numerical" | "GridCellRenderArgs" | "element" | "TableView" | "User" | "Menu" | "Project" | "event_data" | "progressindicator" | "Credentials" | "ScriptEnvironment" | "Notebook"	undefined
defaultValue	any	null
options	null | object & IProperty	null

Returns

any

Inherited from

View . addProperty

See

Registered property gets added to properties. Returns default value, thus allowing to combine registering a property with the initialization

Source

src/widgets.ts:318

---

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

---

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

---

apply()

apply(properties): Widget<any>

Parameters

Parameter	Type	Description
properties	object

Returns

Widget<any>

Inherited from

View . apply

Source

src/widgets.ts:257

---

close()

close(): void

Closes this view.

Returns

void

Inherited from

View . close

Source

src/views/view.ts:201

---

detach()

detach(): void

Detaches this view.

Returns

void

Inherited from

View . detach

Source

src/views/view.ts:196

---

getDartProperties()

getDartProperties(): any[]

Returns

any[]

Inherited from

View . getDartProperties

Source

src/widgets.ts:278

---

getFunctions()

getFunctions(): Func[]

Functions that are applicable to this particular widget. Used in the UI to display context actions, and for the AI integrations.

Returns

Func[]

Inherited from

View . getFunctions

Source

src/views/view.ts:264

---

getIcon()

getIcon(): null | HTMLElement

Returns

null | HTMLElement

View icon. Override in subclasses.

Inherited from

View . getIcon

Source

src/views/view.ts:160

---

getInfo()

getInfo(): ViewLayout

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

Returns

ViewLayout

Inherited from

View . getInfo

Source

src/views/view.ts:313

---

getProperties()

getProperties(): Property[]

Returns all properties of this widget.

Returns

Property[]

Inherited from

View . getProperties

Source

src/views/view.ts:263

---

getRibbonPanels()

getRibbonPanels(): HTMLElement[][]

Returns

HTMLElement[][]

Inherited from

View . getRibbonPanels

Source

src/views/view.ts:155

---

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

---

initDock()

initDock(): string

Returns

string

Source

src/views/view.ts:672

---

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

---

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

---

onFrameAttached()

onFrameAttached(dataFrame): void

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Inherited from

View . onFrameAttached

Source

src/widgets.ts:284

---

onPropertyChanged()

onPropertyChanged(property): void

Gets called when viewer's property is changed.

Parameters

Parameter	Type	Description
property	null | Property	or null, if multiple properties were changed.

Returns

void

Inherited from

View . onPropertyChanged

Source

src/widgets.ts:276

---

pin()

pin(): void

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

Returns

void

Inherited from

View . pin

Source

src/views/view.ts:291

---

saveLayout()

saveLayout(options?): ViewLayout

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

Parameters

Parameter	Type
options?	object
options.saveWithData?	boolean

Returns

ViewLayout

Inherited from

View . saveLayout

Source

src/views/view.ts:306

---

saveStateMap()

saveStateMap(): null | object

Returns

null | object

Viewer state map. Override in subclasses.

Inherited from

View . saveStateMap

Source

src/views/view.ts:165

---

setIcon()

setIcon(icon): void

Parameters

Parameter	Type
icon	HTMLElement

Returns

void

Inherited from

View . setIcon

Source

src/views/view.ts:162

---

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

---

sourceRowsChanged()

sourceRowsChanged(): void

Returns

void

Inherited from

View . sourceRowsChanged

Source

src/widgets.ts:282

---

sub()

sub(subscription): void

Registers a subscription to an external event.

Parameters

Parameter	Type	Description
subscription	Subscription

Returns

void

Inherited from

View . sub

Source

src/widgets.ts:250

---

toDart()

toDart(): any

Returns

any

Inherited from

View . toDart

Source

src/widgets.ts:242

---

create()

static create(options?): View

Creates a new empty view.

Parameters

Parameter	Type	Description
options?	null | string | object

Returns

View

Inherited from

View . create

Source

src/views/view.ts:247

---

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

---

find()

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

Finds existing widget from its visual root.

Parameters

Parameter	Type
root	Element

Returns

null | Widget<any>

Inherited from

View . find

Source

src/widgets.ts:238

---

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

---

fromDart()

static fromDart(dart): TableView | View

Parameters

Parameter	Type
dart	any

Returns

TableView | View

Inherited from

View . fromDart

Source

src/views/view.ts:224

---

fromRoot()

static fromRoot(root): View

Creates and returns a view with the specified element inside.

Parameters

Parameter	Type
root	HTMLElement

Returns

View

Inherited from

View . fromRoot

Source

src/views/view.ts:238

---

fromViewAsync()

static fromViewAsync(getViewAsync, ribbon): any

Parameters

Parameter	Type	Default value
getViewAsync	() => Promise <View>	undefined
ribbon	boolean	true

Returns

any

Inherited from

View . fromViewAsync

Source

src/views/view.ts:259

---

getAll()

static getAll(): Widget<any>[]

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

View . getAll

Source

src/widgets.ts:233