ViewBase

Subclass ViewBase to implement a Datagrok view in JavaScript.

Extends

• Widget

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

Overrides

Widget . constructor

Constructs

ViewBase

Source

src/views/view.ts:57

Properties

Property	Modifier	Type	Default value	Description	Overrides	Inherited from
_closing	private	boolean	undefined	-	-	-
_functions	protected	Func[]	[]	-	Widget._functions	Widget._functions
_helpUrl	private	null | string	null	-	-	-
_name	protected	string	'New View'	-	-	-
_properties	protected	Property[]	[]	-	Widget._properties	Widget._properties
_root	protected	HTMLElement	undefined	-	Widget._root	Widget._root
dart	public	any	undefined	-	Widget.dart	Widget.dart
factory	public	null | Func	null	Constructor function. No parameters, returns [Widget].	Widget.factory	Widget.factory
isDetached	public	boolean	false	-	Widget.isDetached	Widget.isDetached
props	public	any	undefined	-	Widget.props	Widget.props
subs	public	Subscription[]	undefined	-	Widget.subs	Widget.subs
temp	public	any	undefined	Contains auxiliary information	Widget.temp	Widget.temp

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

set description(s): void

Parameters

Parameter	Type
s	string

Returns

string

Source

src/views/view.ts:119

---

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

---

name

get name(): string

set name(s): void

Parameters

Parameter	Type
s	string

Returns

string

Source

src/views/view.ts:104

---

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

Widget's visual root.

set root(newRoot): void

Parameters

Parameter	Type
newRoot	HTMLElement

Returns

HTMLElement

Source

src/views/view.ts:71

---

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

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

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

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

Source

src/views/view.ts:191

---

apply()

apply(properties): Widget<any>

Parameters

Parameter	Type	Description
properties	object

Returns

Widget<any>

Inherited from

Widget . apply

Source

src/widgets.ts:257

---

close()

close(): void

Closes this view.

Returns

void

Source

src/views/view.ts:201

---

detach()

detach(): void

Detaches this view.

Returns

void

Overrides

Widget . detach

Source

src/views/view.ts:196

---

getDartProperties()

getDartProperties(): any[]

Returns

any[]

Inherited from

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

Widget . getFunctions

Source

src/widgets.ts:272

---

getIcon()

getIcon(): null | HTMLElement

Returns

null | HTMLElement

View icon. Override in subclasses.

Source

src/views/view.ts:160

---

getProperties()

getProperties(): Property[]

Returns all properties of this widget.

Returns

Property[]

Inherited from

Widget . getProperties

Source

src/widgets.ts:268

---

getRibbonPanels()

getRibbonPanels(): HTMLElement[][]

Returns

HTMLElement[][]

Source

src/views/view.ts:155

---

handlePath()

handlePath(_urlPath): void

Handles URL path. Override in subclasses.

Parameters

Parameter	Type
_urlPath	string

Returns

void

Source

src/views/view.ts:175

---

loadStateMap()

loadStateMap(_stateMap): void

Loads view state map. Override in subclasses.

Parameters

Parameter	Type
_stateMap	object

Returns

void

Source

src/views/view.ts:168

---

onFrameAttached()

onFrameAttached(dataFrame): void

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Inherited from

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

Widget . onPropertyChanged

Source

src/widgets.ts:276

---

saveStateMap()

saveStateMap(): null | object

Returns

null | object

Viewer state map. Override in subclasses.

Source

src/views/view.ts:165

---

setIcon()

setIcon(icon): void

Parameters

Parameter	Type
icon	HTMLElement

Returns

void

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

Source

src/views/view.ts:151

---

sourceRowsChanged()

sourceRowsChanged(): void

Returns

void

Inherited from

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

Widget . sub

Source

src/widgets.ts:250

---

toDart()

toDart(): any

Returns

any

Inherited from

Widget . toDart

Source

src/widgets.ts:242

---

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

Widget . find

Source

src/widgets.ts:238

---

fromRoot()

static fromRoot(root): Widget<any>

Creates a new widget from the root element.

Parameters

Parameter	Type
root	HTMLElement

Returns

Widget<any>

Inherited from

Widget . fromRoot

Source

src/widgets.ts:341

---

getAll()

static getAll(): Widget<any>[]

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

Widget . getAll

Source

src/widgets.ts:233