ViewBase

Subclass ViewBase to implement a Datagrok view in JavaScript.

Extended by

• View
• MultiView

Constructors

new ViewBase()

new ViewBase(params, path, createHost): ViewBase

Parameters

Parameter	Type	Default value	Description
params	null | object	null	URL parameters.
path	string	''	URL path.
createHost	boolean	true	Create JS host wrapper.

Returns

ViewBase

Constructs

ViewBase

Source

src/views/view.ts:54

Properties

Property	Modifier	Type	Default value
_closing	private	boolean	undefined
_helpUrl	private	null | string	null
_name	protected	string	'New View'
_root	protected	HTMLElement	undefined
dart	public	any	undefined
subs	public	Subscription[]	undefined

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

---

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

---

name

get name(): string

set name(s): void

Parameters

Parameter	Type
s	string

Returns

string

Source

src/views/view.ts:109

---

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

set root(newRoot): void

Parameters

Parameter	Type
newRoot	HTMLElement

Returns

HTMLElement

Source

src/views/view.ts:69

---

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

Methods

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.

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

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

Source

src/views/view.ts:194

---

close()

close(): void

Closes this view.

Returns

void

Source

src/views/view.ts:204

---

detach()

detach(): void

Detaches this view.

Returns

void

Source

src/views/view.ts:199

---

getIcon()

getIcon(): null | HTMLElement

Returns

null | HTMLElement

View icon. Override in subclasses.

Source

src/views/view.ts:165

---

getRibbonPanels()

getRibbonPanels(): HTMLElement[][]

Returns

HTMLElement[][]

Source

src/views/view.ts:160

---

handlePath()

handlePath(_urlPath): void

Handles URL path. Override in subclasses.

Parameters

Parameter	Type
_urlPath	string

Returns

void

Source

src/views/view.ts:178

---

loadStateMap()

loadStateMap(_stateMap): void

Loads view state map. Override in subclasses.

Parameters

Parameter	Type
_stateMap	object

Returns

void

Source

src/views/view.ts:171

---

saveStateMap()

saveStateMap(): null | object

Returns

null | object

Viewer state map. Override in subclasses.

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

Source

src/views/view.ts:156