MultiView

Defined in: src/views/multi_view.ts:20

Subclass ViewBase to implement a Datagrok view in JavaScript.

Extends

ViewBase

Constructors

Constructor

new MultiView(options?): MultiView

Defined in: src/views/multi_view.ts:27

Parameters

Parameter	Type
`options?`	`MultiViewOptions`

Returns

MultiView

Overrides

ViewBase.constructor

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
`_currentView`	`public`	`ViewBase`	`undefined`	-	-	src/views/multi_view.ts:23
`_functions`	`protected`	`Func`[]	`[]`	-	`ViewBase`.`_functions`	src/widgets/base.ts:243
`_name`	`protected`	`string`	`'New View'`	-	`ViewBase`.`_name`	src/views/view.ts:100
`_options?`	`public`	`MultiViewOptions`	`undefined`	-	-	src/views/multi_view.ts:22
`_properties`	`protected`	`Property`[]	`[]`	-	`ViewBase`.`_properties`	src/widgets/base.ts:242
`_root`	`protected`	`HTMLElement`	`undefined`	-	`ViewBase`.`_root`	src/widgets/base.ts:241
`_views`	`public`	`Map`<`String`, `ViewBase`>	`undefined`	-	-	src/views/multi_view.ts:21
`dart`	`public`	`any`	`undefined`	-	`ViewBase`.`dart`	src/views/view.ts:46
`factory`	`public`	`Func` \| `null`	`null`	Constructor function. No parameters, returns [Widget].	`ViewBase`.`factory`	src/widgets/base.ts:239
`isDetached`	`public`	`boolean`	`false`	-	`ViewBase`.`isDetached`	src/widgets/base.ts:247
`props`	`public`	`any`	`undefined`	-	`ViewBase`.`props`	src/widgets/base.ts:244
`subs`	`public`	`Subscription`[]	`undefined`	-	`ViewBase`.`subs`	src/views/view.ts:47
`tabs`	`public`	`TabControl`	`undefined`	-	-	src/views/multi_view.ts:24
`temp`	`public`	`any`	`undefined`	Contains auxiliary information	`ViewBase`.`temp`	src/widgets/base.ts:236

Accessors

basePath

Get Signature

get basePath(): string

Defined in: src/views/view.ts:125

Deprecated

use path instead

Returns

string

Set Signature

set basePath(s): void

Defined in: src/views/view.ts:126

Parameters

Parameter	Type
`s`	`string`

Returns

void

Inherited from

ViewBase.basePath

box

Get Signature

get box(): boolean

Defined in: src/views/view.ts:73

Returns

boolean

Set Signature

set box(b): void

Defined in: src/views/view.ts:74

Parameters

Parameter	Type
`b`	`boolean`

Returns

void

Inherited from

ViewBase.box

children

Get Signature

get children(): Widget<any>[]

Defined in: src/widgets/base.ts:320

Parent widget up the DOM tree, or null.

Returns

Widget<any>[]

Inherited from

ViewBase.children

closing

Get Signature

get closing(): boolean

Defined in: src/views/view.ts:143

Whether the view is currently closing.

Returns

boolean

Set Signature

set closing(c): void

Defined in: src/views/view.ts:144

Parameters

Parameter	Type
`c`	`boolean`

Returns

void

Inherited from

ViewBase.closing

currentView

Get Signature

get currentView(): ViewBase

Defined in: src/views/multi_view.ts:85

Returns

ViewBase

Set Signature

set currentView(x): void

Defined in: src/views/multi_view.ts:86

Parameters

Parameter	Type
`x`	`ViewBase`

Returns

void

description

Get Signature

get description(): string

Defined in: src/views/view.ts:118

Returns

string

Set Signature

set description(s): void

Defined in: src/views/view.ts:119

Parameters

Parameter	Type
`s`	`string`

Returns

void

Inherited from

ViewBase.description

entity

Get Signature

get entity(): object | null

Defined in: src/views/view.ts:121

Returns

object | null

Set Signature

set entity(_e): void

Defined in: src/views/view.ts:122

Parameters

Parameter	Type
`_e`	`object` \| `null`

Returns

void

Inherited from

ViewBase.entity

helpUrl

Get Signature

get helpUrl(): string | null

Defined in: src/views/view.ts:88

Returns

string | null

View help URL.

Set Signature

set helpUrl(url): void

Defined in: src/views/view.ts:92

Parameters

Parameter	Type
`url`	`string` \| `null`

Returns

void

Inherited from

ViewBase.helpUrl

name

Get Signature

get name(): string

Defined in: src/views/multi_view.ts:76

Returns

string

Set Signature

set name(s): void

Defined in: src/views/multi_view.ts:80

Parameters

Parameter	Type
`s`	`string`

Returns

void

Overrides

ViewBase.name

parent

Get Signature

get parent(): Widget<any> | null

Defined in: src/widgets/base.ts:317

Parent widget up the DOM tree, or null.

Returns

Widget<any> | null

Inherited from

ViewBase.parent

parentCall

Get Signature

get parentCall(): FuncCall | undefined

Defined in: src/views/view.ts:112

Returns

FuncCall | undefined

Set Signature

set parentCall(s): void

Defined in: src/views/view.ts:113

Parameters

Parameter	Type
`s`	`FuncCall` \| `undefined`

Returns

void

Inherited from

ViewBase.parentCall

parentView

Get Signature

get parentView(): ViewBase

Defined in: src/views/view.ts:115

Returns

ViewBase

Set Signature

set parentView(s): void

Defined in: src/views/view.ts:116

Parameters

Parameter	Type
`s`	`ViewBase`

Returns

void

Inherited from

ViewBase.parentView

path

Get Signature

get path(): string

Defined in: src/views/view.ts:170

View URI, relative to the view root

Returns

string

Set Signature

set path(s): void

Defined in: src/views/view.ts:171

Parameters

Parameter	Type
`s`	`string`

Returns

void

Inherited from

ViewBase.path

ribbonMenu

Get Signature

get ribbonMenu(): Menu

Defined in: src/views/view.ts:135

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

Returns

Menu

Set Signature

set ribbonMenu(menu): void

Defined in: src/views/view.ts:136

Parameters

Parameter	Type
`menu`	`Menu`

Returns

void

Inherited from

ViewBase.ribbonMenu

root

Get Signature

get root(): HTMLElement

Defined in: src/views/view.ts:70

Widget's visual root.

Returns

HTMLElement

Set Signature

set root(newRoot): void

Defined in: src/views/view.ts:71

Widget's visual root.

Parameters

Parameter	Type
`newRoot`	`HTMLElement`

Returns

void

Inherited from

ViewBase.root

statusBarPanels

Get Signature

get statusBarPanels(): HTMLDivElement[]

Defined in: src/views/view.ts:139

Status bar panels to be shown on the bottom

Returns

HTMLDivElement[]

Set Signature

set statusBarPanels(panels): void

Defined in: src/views/view.ts:140

Parameters

Parameter	Type
`panels`	`HTMLDivElement`[]

Returns

void

Inherited from

ViewBase.statusBarPanels

toolbox

Get Signature

get toolbox(): HTMLElement

Defined in: src/views/view.ts:130

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

Returns

HTMLElement

Set Signature

set toolbox(x): void

Defined in: src/views/view.ts:131

Parameters

Parameter	Type
`x`	`HTMLElement`

Returns

void

Inherited from

ViewBase.toolbox

type

Get Signature

get type(): string

Defined in: src/views/view.ts:83

View type

Returns

string

Inherited from

ViewBase.type

Methods

_getFactory()

_getFactory(factory): ViewDescription | ViewFactory

Defined in: src/views/multi_view.ts:61

Parameters

Parameter	Type
`factory`	`ViewDescription` \| `ViewFactory`

Returns

ViewDescription | ViewFactory

acceptsPath()

acceptsPath(_urlPath): boolean

Defined in: src/views/view.ts:178

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

addView()

addView(name, desc, activate): void

Defined in: src/views/multi_view.ts:56

Parameters

Parameter	Type
`name`	`string`
`desc`	`ViewDescription` \| `ViewFactory`
`activate`	`boolean`

Returns

void

append()

append(item): HTMLElement

Defined in: src/views/view.ts:183

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

Parameters

Parameter	Type	Description
`item`	`any`	-

Returns

HTMLElement

Inherited from

ViewBase.append

appendAll()

appendAll(items): HTMLElement

Defined in: src/views/view.ts:190

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

Parameters

Parameter	Type	Description
`items`	`HTMLElement`[]	-

Returns

HTMLElement

Inherited from

ViewBase.appendAll

apply()

apply(properties): Widget

Defined in: src/widgets/base.ts:284

Parameters

Parameter	Type	Description
`properties`	`object`	-

Returns

Widget

Inherited from

ViewBase.apply

close()

close(): void

Defined in: src/views/view.ts:200

Closes this view.

Returns

void

Inherited from

ViewBase.close

detach()

detach(): void

Defined in: src/views/view.ts:195

Detaches this view.

Returns

void

Inherited from

ViewBase.detach

getDartProperties()

getDartProperties(): any[]

Defined in: src/widgets/base.ts:305

Returns

any[]

Inherited from

ViewBase.getDartProperties

getFunctions()

getFunctions(): Func[]

Defined in: src/widgets/base.ts:299

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

ViewBase.getFunctions

getIcon()

getIcon(): HTMLElement | null

Defined in: src/views/view.ts:159

Returns

HTMLElement | null

View icon. Override in subclasses.

Inherited from

ViewBase.getIcon

getProperties()

getProperties(): Property[]

Defined in: src/widgets/base.ts:295

Returns all properties of this widget.

Returns

Property[]

Inherited from

ViewBase.getProperties

getRibbonPanels()

getRibbonPanels(): HTMLElement[][]

Defined in: src/views/view.ts:154

Returns

HTMLElement[][]

Inherited from

ViewBase.getRibbonPanels

getView()

getView(name): ViewBase

Defined in: src/views/multi_view.ts:68

Parameters

Parameter	Type
`name`	`string`

Returns

ViewBase

getWidgetStatus()

getWidgetStatus(): IWidgetStatus

Defined in: src/widgets/base.ts:371

Returns the widget's runtime structure for automated testing and introspection.

Returns

IWidgetStatus

Inherited from

ViewBase.getWidgetStatus

handlePath()

handlePath(_urlPath): void

Defined in: src/views/view.ts:174

Handles URL path. Override in subclasses.

Parameters

Parameter	Type
`_urlPath`	`string`

Returns

void

Inherited from

ViewBase.handlePath

loadStateMap()

loadStateMap(_stateMap): void

Defined in: src/views/view.ts:167

Loads view state map. Override in subclasses.

Parameters

Parameter	Type
`_stateMap`	`object`

Returns

void

Inherited from

ViewBase.loadStateMap

onEvent()

onEvent(eventId?): Observable<any>

Defined in: src/widgets/base.ts:368

Observes events with the specified eventId. Override in subclasses to provide actual events.

Parameters

Parameter	Type	Default value
`eventId`	`string` \| `null`	`null`

Returns

Observable<any>

Inherited from

ViewBase.onEvent

onFrameAttached()

onFrameAttached(dataFrame): void

Defined in: src/widgets/base.ts:311

Parameters

Parameter	Type
`dataFrame`	`DataFrame`

Returns

void

Inherited from

ViewBase.onFrameAttached

onPropertyChanged()

onPropertyChanged(property): void

Defined in: src/widgets/base.ts:303

Gets called when viewer's property is changed.

Parameters

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

Returns

void

Inherited from

ViewBase.onPropertyChanged

saveStateMap()

saveStateMap(): object | null

Defined in: src/views/view.ts:164

Returns

object | null

Viewer state map. Override in subclasses.

Inherited from

ViewBase.saveStateMap

setIcon()

setIcon(icon): void

Defined in: src/views/view.ts:161

Parameters

Parameter	Type
`icon`	`HTMLElement`

Returns

void

Inherited from

ViewBase.setIcon

setRibbonPanels()

setRibbonPanels(panels, clear?): void

Defined in: src/views/view.ts:150

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

sourceRowsChanged()

sourceRowsChanged(): void

Defined in: src/widgets/base.ts:309

Returns

void

Inherited from

ViewBase.sourceRowsChanged

sub()

sub(subscription): void

Defined in: src/widgets/base.ts:277

Registers a subscription to an external event.

Parameters

Parameter	Type	Description
`subscription`	`Subscription`	-

Returns

void

Inherited from

ViewBase.sub

toDart()

toDart(): any

Defined in: src/widgets/base.ts:269

Returns

any

Inherited from

ViewBase.toDart

find()

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

Defined in: src/widgets/base.ts:265

Finds existing widget from its visual root.

Parameters

Parameter	Type
`root`	`Element`

Returns

Widget<any> | null

Inherited from

ViewBase.find

fromRoot()

static fromRoot(root): Widget

Defined in: src/widgets/base.ts:374

Creates a new widget from the root element.

Parameters

Parameter	Type
`root`	`HTMLElement`

Returns

Widget

Inherited from

ViewBase.fromRoot

getAll()

static getAll(): Widget<any>[]

Defined in: src/widgets/base.ts:260

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

ViewBase.getAll

Extends​

Constructors​

Constructor​

Parameters​

Returns​

Overrides​

Properties​

Accessors​

basePath​

Get Signature​

Deprecated​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

box​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

children​

Get Signature​

Returns​

Inherited from​

closing​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

currentView​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

description​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

entity​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

helpUrl​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

name​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Overrides​

parent​

Get Signature​

Returns​

Inherited from​

parentCall​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

parentView​

Extends

Constructors

Constructor

Parameters

Returns

Overrides

Properties

Accessors

basePath

Get Signature

Deprecated

Returns

Set Signature

Parameters

Returns

Inherited from

box

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

children

Get Signature

Returns

Inherited from

closing

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

currentView

Get Signature

Returns

Set Signature

Parameters

Returns

description

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

entity

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

helpUrl

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

name

Get Signature

Returns

Set Signature

Parameters

Returns

Overrides

parent

Get Signature

Returns

Inherited from

parentCall

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

parentView