Class: ViewBase

dg.ViewBase

Subclass ViewBase to implement a Datagrok view in JavaScript.

Hierarchy

• ViewBase

  ↳ View

  ↳ MultiView

Constructors

constructor

• new ViewBase(params?, path?, createHost?)

Constructs

ViewBase

Parameters

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

Defined in

src/views/view.ts:35

Properties

_closing

• Private _closing: boolean

Defined in

src/views/view.ts:27

---

_helpUrl

• Private _helpUrl: null | string = null

Defined in

src/views/view.ts:25

---

_name

• Protected _name: string = 'New View'

Defined in

src/views/view.ts:87

---

_path

• Private _path: null | string = null

Defined in

src/views/view.ts:28

---

_root

• Protected _root: HTMLElement

Defined in

src/views/view.ts:26

---

dart

• dart: any

Defined in

src/views/view.ts:23

---

subs

• subs: Subscription[]

Defined in

src/views/view.ts:24

Accessors

basePath

• get basePath(): string

Deprecated

use path instead

Returns

string

Defined in

src/views/view.ts:112

• set basePath(s): void

Parameters

Name	Type
s	string

Returns

void

Defined in

src/views/view.ts:113

---

box

• get box(): boolean

Returns

boolean

Defined in

src/views/view.ts:58

• set box(b): void

Parameters

Name	Type
b	boolean

Returns

void

Defined in

src/views/view.ts:62

---

closing

• get closing(): boolean

Whether the view is currently closing.

Returns

boolean

Defined in

src/views/view.ts:130

• set closing(c): void

Parameters

Name	Type
c	boolean

Returns

void

Defined in

src/views/view.ts:131

---

description

• get description(): string

Returns

string

Defined in

src/views/view.ts:105

• set description(s): void

Parameters

Name	Type
s	string

Returns

void

Defined in

src/views/view.ts:106

---

entity

• get entity(): null | object

Returns

null | object

Defined in

src/views/view.ts:108

• set entity(e): void

Parameters

Name	Type
e	null | object

Returns

void

Defined in

src/views/view.ts:109

---

helpUrl

• get helpUrl(): null | string

Returns

null | string

View help URL.

Defined in

src/views/view.ts:75

• set helpUrl(url): void

Parameters

Name	Type
url	null | string

Returns

void

Defined in

src/views/view.ts:79

---

name

• get name(): string

Returns

string

Defined in

src/views/view.ts:90

• set name(s): void

Parameters

Name	Type
s	string

Returns

void

Defined in

src/views/view.ts:94

---

parentCall

• get parentCall(): undefined | FuncCall

Returns

undefined | FuncCall

Defined in

src/views/view.ts:99

• set parentCall(s): void

Parameters

Name	Type
s	undefined | FuncCall

Returns

void

Defined in

src/views/view.ts:100

---

parentView

• get parentView(): ViewBase

Returns

ViewBase

Defined in

src/views/view.ts:102

• set parentView(s): void

Parameters

Name	Type
s	ViewBase

Returns

void

Defined in

src/views/view.ts:103

---

path

• get path(): string

View URI, relative to the view root

Returns

string

Defined in

src/views/view.ts:163

• set path(s): void

Parameters

Name	Type
s	string

Returns

void

Defined in

src/views/view.ts:167

---

ribbonMenu

• get ribbonMenu(): Menu

View menu. Sample: https://public.datagrok.ai/js/samples/ui/views/ribbon

Returns

Menu

Defined in

src/views/view.ts:122

• set ribbonMenu(menu): void

Parameters

Name	Type
menu	Menu

Returns

void

Defined in

src/views/view.ts:123

---

root

• get root(): HTMLElement

Returns

HTMLElement

Defined in

src/views/view.ts:50

• set root(newRoot): void

Parameters

Name	Type
newRoot	HTMLElement

Returns

void

Defined in

src/views/view.ts:54

---

statusBarPanels

• get statusBarPanels(): HTMLDivElement[]

Status bar panels to be shown on the bottom

Returns

HTMLDivElement[]

Defined in

src/views/view.ts:126

• set statusBarPanels(panels): void

Parameters

Name	Type
panels	HTMLDivElement[]

Returns

void

Defined in

src/views/view.ts:127

---

toolbox

• get toolbox(): HTMLElement

View toolbox. Sample: https://public.datagrok.ai/js/samples/ui/views/toolbox

Returns

HTMLElement

Defined in

src/views/view.ts:117

• set toolbox(x): void

Parameters

Name	Type
x	HTMLElement

Returns

void

Defined in

src/views/view.ts:118

---

type

• get type(): string

View type

Returns

string

Defined in

src/views/view.ts:70

Methods

acceptsPath

▸ acceptsPath(path): boolean

Checks if URL path is acceptable.

Parameters

Name	Type	Description
path	string	URL path.

Returns

boolean

"true" if path is acceptable, "false" otherwise.

Defined in

src/views/view.ts:179

---

append

▸ append(item): HTMLElement

Appends an item to this view. Use appendAll for appending multiple elements.

Parameters

Name	Type
item	any

Returns

HTMLElement

Defined in

src/views/view.ts:186

---

appendAll

▸ appendAll(items): HTMLElement

Appends multiple elements this view. Use append for appending a single element.

Parameters

Name	Type
items	HTMLElement[]

Returns

HTMLElement

Defined in

src/views/view.ts:193

---

close

▸ close(): void

Closes this view.

Returns

void

Defined in

src/views/view.ts:203

---

detach

▸ detach(): void

Detaches this view.

Returns

void

Defined in

src/views/view.ts:198

---

getIcon

▸ getIcon(): null | HTMLElement

Returns

null | HTMLElement

View icon.

Defined in

src/views/view.ts:146

---

getRibbonPanels

▸ getRibbonPanels(): HTMLElement[][]

Returns

HTMLElement[][]

Defined in

src/views/view.ts:141

---

handlePath

▸ handlePath(path): void

Handles URL path.

Parameters

Name	Type	Description
path	string	URL path.

Returns

void

Defined in

src/views/view.ts:173

---

loadStateMap

▸ loadStateMap(stateMap): void

Load view state map.

Parameters

Name	Type	Description
stateMap	object	State map.

Returns

void

Defined in

src/views/view.ts:157

---

saveStateMap

▸ saveStateMap(): null | object

Returns

null | object

Viewer state map.

Defined in

src/views/view.ts:151

---

setRibbonPanels

▸ setRibbonPanels(panels, clear?): void

Sets custom view panels on the ribbon.

Parameters

Name	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

Defined in

src/views/view.ts:137