MultiView
Defined in: js-api/src/views/multi_view.ts:20
Subclass ViewBase to implement a Datagrok view in JavaScript.
Extends
Constructors
Constructor
new MultiView(
options?):MultiView
Defined in: js-api/src/views/multi_view.ts:29
Parameters
| Parameter | Type |
|---|---|
options? | MultiViewOptions |
Returns
MultiView
Overrides
Properties
| Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
|---|---|---|---|---|---|---|
_currentView | public | ViewBase | undefined | - | - | js-api/src/views/multi_view.ts:23 |
_functions | protected | Func[] | [] | - | ViewBase._functions | js-api/src/widgets/base.ts:218 |
_name | protected | string | 'New View' | - | ViewBase._name | js-api/src/views/view.ts:108 |
_options | public | MultiViewOptions | undefined | - | - | js-api/src/views/multi_view.ts:22 |
_properties | protected | Property[] | [] | - | ViewBase._properties | js-api/src/widgets/base.ts:217 |
_root | protected | HTMLElement | undefined | - | ViewBase._root | js-api/src/u2core/component.ts:666 |
_u2 | readonly | ComponentState | undefined | - | ViewBase._u2 | js-api/src/u2core/component.ts:119 |
_views | public | Map<String, ViewBase> | undefined | - | - | js-api/src/views/multi_view.ts:21 |
componentMeta? | public | ComponentMetaBase | undefined | The registry metadata of the tag that built this component, stamped by the spec renderer — the single source the introspection surface below is generated from. | ViewBase.componentMeta | js-api/src/u2core/component.ts:114 |
dart | public | any | undefined | - | ViewBase.dart | js-api/src/views/view.ts:49 |
factory | public | Func | null | null | Constructor function. No parameters, returns [Widget]. | ViewBase.factory | js-api/src/widgets/base.ts:215 |
isDetached | public | boolean | false | Whether detach has been called. | ViewBase.isDetached | js-api/src/widgets/base.ts:225 |
props | public | any | undefined | Property bag over this widget's properties; read and write them by name. | ViewBase.props | js-api/src/widgets/base.ts:220 |
specProps? | public | Record<string, unknown> | undefined | The props the registry's create was handed, stamped alongside componentMeta: the last resort of the property read below, for a component that keeps a prop under another name or not at all (a create wrapping a bare element). Construction-time values — a live one always wins. | ViewBase.specProps | js-api/src/u2core/component.ts:118 |
subs | public | Subscription[] | undefined | Subscriptions cancelled when the widget is detached. | ViewBase.subs | js-api/src/views/view.ts:50 |
tabs | public | TabControl | undefined | - | - | js-api/src/views/multi_view.ts:24 |
temp | public | any | undefined | Contains auxiliary information | ViewBase.temp | js-api/src/widgets/base.ts:212 |
isRoot | static | boolean | false | A root has no owner by design (a dialog): built with none, it is not reported as owner-missing. | ViewBase.isRoot | js-api/src/u2core/component.ts:81 |
Accessors
aiDescription
Get Signature
get aiDescription():
string|null
Defined in: js-api/src/u2core/component.ts:337
A short AI-facing briefing, seeded from the registry's usage or description.
Returns
string | null
Set Signature
set aiDescription(
x):void
Defined in: js-api/src/u2core/component.ts:341
Parameters
| Parameter | Type |
|---|---|
x | string | null |
Returns
void
Inherited from
ambientAdoption
Get Signature
get
protectedambientAdoption():boolean
Defined in: js-api/src/widgets/base.ts:278
A widget wrapper minted inside somebody's effect scope must not be auto-disposed with it.
Returns
boolean
Inherited from
basePath
Get Signature
get basePath():
string
Defined in: js-api/src/views/view.ts:141
URL prefix of the view (an app's root, such as /apps/Chem); path is this prefix plus the
view's own relative path.
Returns
string
Set Signature
set basePath(
s):void
Defined in: js-api/src/views/view.ts:142
Parameters
| Parameter | Type |
|---|---|
s | string |
Returns
void
Inherited from
box
Get Signature
get box():
boolean
Defined in: js-api/src/views/view.ts:75
Returns
boolean
Set Signature
set box(
b):void
Defined in: js-api/src/views/view.ts:76
Parameters
| Parameter | Type |
|---|---|
b | boolean |
Returns
void
Inherited from
children
Get Signature
get children():
Widget<any>[]
Defined in: js-api/src/widgets/base.ts:313
Parent widget up the DOM tree, or null.
Returns
Widget<any>[]
Inherited from
closing
Get Signature
get closing():
boolean
Defined in: js-api/src/views/view.ts:169
Whether the view is currently closing.
Returns
boolean
Set Signature
set closing(
c):void
Defined in: js-api/src/views/view.ts:170
Parameters
| Parameter | Type |
|---|---|
c | boolean |
Returns
void
Inherited from
currentView
Get Signature
get currentView():
ViewBase
Defined in: js-api/src/views/multi_view.ts:112
Returns
Set Signature
set currentView(
x):void
Defined in: js-api/src/views/multi_view.ts:113
Parameters
| Parameter | Type |
|---|---|
x | ViewBase |
Returns
void
description
Get Signature
get description():
string
Defined in: js-api/src/views/view.ts:133
Returns
string
Set Signature
set description(
s):void
Defined in: js-api/src/views/view.ts:134
Parameters
| Parameter | Type |
|---|---|
s | string |
Returns
void
Inherited from
entity
Get Signature
get entity():
object|null
Defined in: js-api/src/views/view.ts:136
Returns
object | null
Set Signature
set entity(
_e):void
Defined in: js-api/src/views/view.ts:137
Parameters
| Parameter | Type |
|---|---|
_e | object | null |
Returns
void
Inherited from
helpUrl
Get Signature
get helpUrl():
string|null
Defined in: js-api/src/views/view.ts:90
Returns
string | null
View help URL.
Set Signature
set helpUrl(
url):void
Defined in: js-api/src/views/view.ts:94
Parameters
| Parameter | Type |
|---|---|
url | string | null |
Returns
void
Inherited from
innerView
Set Signature
set innerView(
v):void
Defined in: js-api/src/views/view.ts:131
The view this one is currently surfacing, if it hosts another (such as a MultiView
tab). grok.shell.t resolves through it.
Parameters
| Parameter | Type |
|---|---|
v | ViewBase | null |
Returns
void
Inherited from
isPinned
Get Signature
get isPinned():
boolean
Defined in: js-api/src/views/view.ts:199
Whether the view is pinned. Pinned views are not closed when a new view is opened.
Returns
boolean
Set Signature
set isPinned(
value):void
Defined in: js-api/src/views/view.ts:200
Parameters
| Parameter | Type |
|---|---|
value | boolean |
Returns
void
Inherited from
name
Get Signature
get name():
string
Defined in: js-api/src/views/multi_view.ts:81
A named control carries its name in the DOM: data-u2-name is the stable automation id
selectors, tutorials and agents address the control by — the same attribute the spec renderer
stamps on named nodes, so hand-built and spec-built UI share one selector vocabulary.
Derived names (an input's label fallback) never stamp — see Component.deriveName.
Returns
string
Set Signature
set name(
s):void
Defined in: js-api/src/views/multi_view.ts:85
A named control carries its name in the DOM: data-u2-name is the stable automation id
selectors, tutorials and agents address the control by — the same attribute the spec renderer
stamps on named nodes, so hand-built and spec-built UI share one selector vocabulary.
Derived names (an input's label fallback) never stamp — see Component.deriveName.
Parameters
| Parameter | Type |
|---|---|
s | string |
Returns
void
Overrides
parent
Get Signature
get parent():
Widget<any> |null
Defined in: js-api/src/widgets/base.ts:310
Parent widget up the DOM tree, or null.
Returns
Widget<any> | null
Inherited from
parentCall
Get Signature
get parentCall():
FuncCall|undefined
Defined in: js-api/src/views/view.ts:120
Returns
FuncCall | undefined
Set Signature
set parentCall(
s):void
Defined in: js-api/src/views/view.ts:121
Parameters
| Parameter | Type |
|---|---|
s | FuncCall | undefined |
Returns
void
Inherited from
parentView
Get Signature
get parentView():
ViewBase
Defined in: js-api/src/views/view.ts:126
The view this one was opened from. While it is open, the ribbon shows it before this view's name as a link that makes it current (a TableView only with TableView.showParentCrumb), and closing this view while it is current makes the parent current.
Returns
Set Signature
set parentView(
s):void
Defined in: js-api/src/views/view.ts:127
Parameters
| Parameter | Type |
|---|---|
s | ViewBase |
Returns
void
Inherited from
path
Get Signature
get path():
string
Defined in: js-api/src/views/view.ts:195
View URI, relative to the view root
Returns
string
Set Signature
set path(
s):void
Defined in: js-api/src/views/view.ts:196
Parameters
| Parameter | Type |
|---|---|
s | string |
Returns
void
Inherited from
propertyTarget
Get Signature
get propertyTarget():
unknown
Defined in: js-api/src/u2core/component.ts:435
What this component's properties are read from and written to — prop.get(target) /
prop.set(target, v): the component itself, unless an adoption says otherwise.
Returns
unknown
Inherited from
propertyTier
Get Signature
get propertyTier():
boolean
Defined in: js-api/src/widgets/base.ts:282
Every property getProperties declares is a bind step, read and written on propertyTarget.
Returns
boolean
Inherited from
ribbonMenu
Get Signature
get ribbonMenu():
Menu
Defined in: js-api/src/views/view.ts:161
View menu. Sample: https://public.datagrok.ai/js/samples/ui/views/ribbon
Returns
Set Signature
set ribbonMenu(
menu):void
Defined in: js-api/src/views/view.ts:162
Parameters
| Parameter | Type |
|---|---|
menu | Menu |
Returns
void
Inherited from
root
Get Signature
get root():
HTMLElement
Defined in: js-api/src/views/view.ts:72
Returns
HTMLElement
Set Signature
set root(
newRoot):void
Defined in: js-api/src/views/view.ts:73
Parameters
| Parameter | Type |
|---|---|
newRoot | HTMLElement |
Returns
void
Inherited from
rootId
Get Signature
get rootId():
string
Defined in: js-api/src/u2core/component.ts:704
Stable element id, minted (u2-<n>) on first ask unless the root has one: the anchor of
for, aria-* and data-u2-owner-id references.
Returns
string
Inherited from
saveToProject
Get Signature
get saveToProject():
boolean
Defined in: js-api/src/views/view.ts:148
Whether the view is saved with the project. Only views that can be reopened are saved: their type restores them from saveStateMap, or they belong to an app. A new view is listed in the Save project dialog but left out until the user includes it, unless saveToProjectByDefault is true; a view of a saved project stays in it.
Returns
boolean
Set Signature
set saveToProject(
x):void
Defined in: js-api/src/views/view.ts:149
Parameters
| Parameter | Type |
|---|---|
x | boolean |
Returns
void
Inherited from
saveToProjectByDefault
Get Signature
get saveToProjectByDefault():
boolean
Defined in: js-api/src/views/view.ts:152
Override to return true for a view type whose new views go into the project without the user including them.
Returns
boolean
Inherited from
ViewBase.saveToProjectByDefault
scope
Get Signature
get scope():
Scope
Defined in: js-api/src/u2core/component.ts:86
Minted on first use; assigned before _scopeMinted fires, so the hook's own
this.scope.own(...) reads the stored scope instead of re-entering the mint. Lazy: counted and tracked only
once it owns something, so a static control costs nothing.
Returns
Inherited from
statusBarPanels
Get Signature
get statusBarPanels():
HTMLDivElement[]
Defined in: js-api/src/views/view.ts:165
Status bar panels to be shown on the bottom
Returns
HTMLDivElement[]
Set Signature
set statusBarPanels(
panels):void
Defined in: js-api/src/views/view.ts:166
Parameters
| Parameter | Type |
|---|---|
panels | HTMLDivElement[] |
Returns
void
Inherited from
toolbox
Get Signature
get toolbox():
HTMLElement
Defined in: js-api/src/views/view.ts:156
View toolbox. Sample: https://public.datagrok.ai/js/samples/ui/views/toolbox
Returns
HTMLElement
Set Signature
set toolbox(
x):void
Defined in: js-api/src/views/view.ts:157
Parameters
| Parameter | Type |
|---|---|
x | HTMLElement |
Returns
void
Inherited from
type
Get Signature
get type():
string
Defined in: js-api/src/views/view.ts:85
View type
Returns
string