View

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

Extends

• ViewBase

Extended by

• TableView
• ScriptView
• DockView
• BrowseView
• CardView

Constructors

new View()

new View(dart): View

Parameters

Parameter	Type
dart	any

Returns

View

Overrides

ViewBase . constructor

Constructs

View

Source

src/views/view.ts:221

Properties

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

---

description

get description(): string

set description(s): void

Parameters

Parameter	Type
s	string

Returns

string

Source

src/views/view.ts:273

---

entity

get entity(): null | object

set entity(_e): void

Parameters

Parameter	Type
_e	null | object

Returns

null | object

Source

src/views/view.ts:127

---

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

---

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

---

type

get type(): string

View type

Returns

string

Source

src/views/view.ts:265

Methods

_onAdded()

_onAdded(): void

Returns

void

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

ViewBase . acceptsPath

Source

src/views/view.ts:182

---

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

ViewBase . 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

ViewBase . appendAll

Source

src/views/view.ts:194

---

close()

close(): void

Closes this view.

Returns

void

Inherited from

ViewBase . close

Source

src/views/view.ts:204

---

detach()

detach(): void

Detaches this view.

Returns

void

Inherited from

ViewBase . detach

Source

src/views/view.ts:199

---

getIcon()

getIcon(): null | HTMLElement

Returns

null | HTMLElement

View icon. Override in subclasses.

Inherited from

ViewBase . getIcon

Source

src/views/view.ts:165

---

getInfo()

getInfo(): ViewLayout

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

Returns

ViewLayout

Source

src/views/view.ts:308

---

getRibbonPanels()

getRibbonPanels(): HTMLElement[][]

Returns

HTMLElement[][]

Inherited from

ViewBase . 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

ViewBase . handlePath

Source

src/views/view.ts:178

---

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

Source

src/views/view.ts:293

---

loadStateMap()

loadStateMap(_stateMap): void

Loads view state map. Override in subclasses.

Parameters

Parameter	Type
_stateMap	object

Returns

void

Inherited from

ViewBase . loadStateMap

Source

src/views/view.ts:171

---

saveLayout()

saveLayout(): ViewLayout

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

Returns

ViewLayout

Source

src/views/view.ts:301

---

saveStateMap()

saveStateMap(): null | object

Returns

null | object

Viewer state map. Override in subclasses.

Inherited from

ViewBase . saveStateMap

Source

src/views/view.ts:168

---

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

ViewBase . setRibbonPanels

Source

src/views/view.ts:156

---

create()

static create(options?): View

Creates a new empty view.

Parameters

Parameter	Type	Description
options?	null | string | object

Returns

View

Source

src/views/view.ts:249

---

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

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

Source

src/views/view.ts:236

---

fromDart()

static fromDart(dart): View | TableView

Parameters

Parameter	Type
dart	any

Returns

View | TableView

Source

src/views/view.ts:227

---

fromRoot()

static fromRoot(root): View

Parameters

Parameter	Type
root	HTMLElement

Returns

View

Source

src/views/view.ts:240