Dialog<Inputs>

Defined in: js-api/src/widgets/forms.ts:29

A non-modal dialog. Sample: https://public.datagrok.ai/js/samples/ui/dialogs/dialogs

Example

ui.dialog('Windows')
  .add(ui.span(['People of Earth, your attention, please… ']))
  .onOK(() => { grok.shell.info('OK!'); })
  .show();

Extends

• DartWidget

Extended by

• Wizard

Type Parameters

Type Parameter	Default type
Inputs extends Record<string, InputBase<any>>	object

Constructors

Constructor

new Dialog<Inputs>(dart): Dialog<Inputs>

Defined in: js-api/src/widgets/forms.ts:31

Parameters

Parameter	Type
dart	any

Returns

Dialog<Inputs>

Overrides

DartWidget.constructor

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
_functions	protected	Func[]	[]	-	DartWidget._functions	js-api/src/widgets/base.ts:218
_properties	protected	Property[]	[]	-	DartWidget._properties	js-api/src/widgets/base.ts:217
_root	protected	HTMLElement	undefined	-	DartWidget._root	js-api/src/u2core/component.ts:666
_u2	readonly	ComponentState	undefined	-	DartWidget._u2	js-api/src/u2core/component.ts:119
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.	DartWidget.componentMeta	js-api/src/u2core/component.ts:114
dart	public	any	undefined	-	DartWidget.dart	js-api/src/widgets/base.ts:223
factory	public	Func | null	null	Constructor function. No parameters, returns [Widget].	DartWidget.factory	js-api/src/widgets/base.ts:215
isDetached	public	boolean	false	Whether detach has been called.	DartWidget.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.	DartWidget.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.	DartWidget.specProps	js-api/src/u2core/component.ts:118
subs	public	Subscription[]	undefined	Subscriptions cancelled when the widget is detached.	DartWidget.subs	js-api/src/widgets/base.ts:222
temp	public	any	undefined	Contains auxiliary information	DartWidget.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.	DartWidget.isRoot	js-api/src/u2core/component.ts:81

Accessors

aiDescription

Get Signature

get aiDescription(): string | null

Defined in: js-api/src/widgets/base.ts:509

AI briefing of the underlying Dart widget.

Returns

string | null

Set Signature

set aiDescription(x): void

Defined in: js-api/src/widgets/base.ts:514

A short AI-facing briefing, seeded from the registry's usage or description.

Parameters

Parameter	Type
x	string | null

Returns

void

Inherited from

DartWidget.aiDescription

---

ambientAdoption

Get Signature

get protected ambientAdoption(): 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

DartWidget.ambientAdoption

---

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

DartWidget.children

---

helpUrl

Get Signature

get helpUrl(): string

Defined in: js-api/src/widgets/forms.ts:44

When provided, adds a "?" icon to the dialog header on the right.

Returns

string

Set Signature

set helpUrl(url): void

Defined in: js-api/src/widgets/forms.ts:45

Parameters

Parameter	Type
url	string

Returns

void

---

inputs

Get Signature

get inputs(): InputBase<any>[]

Defined in: js-api/src/widgets/forms.ts:52

Returns a list of the dialog's inputs.

Returns

InputBase<any>[]

---

name

Get Signature

get name(): string | undefined

Defined in: js-api/src/u2core/component.ts:882

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

Set Signature

set name(x): void

Defined in: js-api/src/u2core/component.ts:886

Unique within a spec: the anchor for selection, patches and automation. An accessor pair (not a field), so a platform descendant's own name accessors override it legally (TS2611).

Parameters

Parameter	Type
x	string | undefined

Returns

void

Inherited from

DartWidget.name

---

namedInputs

Get Signature

get namedInputs(): Inputs

Defined in: js-api/src/widgets/forms.ts:135

gets typed inputs with captions as keys.

Returns

Inputs

---

onAfterOK

Get Signature

get onAfterOK(): Observable<any>

Defined in: js-api/src/widgets/forms.ts:99

Fires after the OK handler completes successfully.

Returns

Observable<any>

---

onBeforeOK

Get Signature

get onBeforeOK(): Observable<any>

Defined in: js-api/src/widgets/forms.ts:96

Fires before the OK handler runs.

Returns

Observable<any>

---

onClose

Get Signature

get onClose(): Observable<any>

Defined in: js-api/src/widgets/forms.ts:91

Returns

Observable<any>

---

onSaveHistoryRequest

Get Signature

get onSaveHistoryRequest(): Observable<any>

Defined in: js-api/src/widgets/forms.ts:102

Fires when the dialog requests to save the current history snapshot.

Returns

Observable<any>

---

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

DartWidget.parent

---

propertyTarget

Get Signature

get propertyTarget(): unknown

Defined in: js-api/src/widgets/base.ts:502

The Dart handle: properties are read from and written to the Dart widget.

Returns

unknown

Inherited from

DartWidget.propertyTarget

---

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

DartWidget.propertyTier

---

root

Get Signature

get root(): HTMLElement

Defined in: js-api/src/widgets/base.ts:500

Visual root of the Dart widget.

Returns

HTMLElement

Inherited from

DartWidget.root

---

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

DartWidget.rootId

---

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

Scope

Inherited from

DartWidget.scope

---

title

Get Signature

get title(): string

Defined in: js-api/src/widgets/forms.ts:48

Returns the title of a dialog.

Returns

string

Set Signature

set title(t): void

Defined in: js-api/src/widgets/forms.ts:49

Parameters

Parameter	Type
t	string

Returns

void

---

type

Get Signature

get type(): string

Defined in: js-api/src/widgets/base.ts:498

Type name the Dart widget reports.

Returns

string

Inherited from

DartWidget.type

---

visible

Get Signature

get visible(): boolean

Defined in: js-api/src/u2core/component.ts:694

Hidden ⇔ the root carries the hidden attribute.

Returns

boolean

Set Signature

set visible(x): void

Defined in: js-api/src/u2core/component.ts:698

Parameters

Parameter	Type
x	boolean

Returns

void

Inherited from

DartWidget.visible

Methods

_notifyPropertyChange()

protected _notifyPropertyChange(p): void

Defined in: js-api/src/widgets/base.ts:360

Notifies the property tier. Called from both the addProperty setter (overrides that skip super would otherwise lose props.x = writes) and onPropertyChanged (direct calls); the double notify collapses into one microtask refresh.

Parameters

Parameter	Type
p	Property | null

Returns

void

Inherited from

DartWidget._notifyPropertyChange

---

_ownPropertyChanges()

protected _ownPropertyChanges(): ObservableLike<PropertyChange>

Defined in: js-api/src/widgets/base.ts:365

Returns

ObservableLike<PropertyChange>

Inherited from

DartWidget._ownPropertyChanges

---

_scopeMinted()

protected _scopeMinted(_scope): void

Defined in: js-api/src/widgets/base.ts:329

First-mint hook: a platform descendant wires its lifecycle here. Never fired for a scope provided to init — that path runs inside the constructor chain.

Parameters

Parameter	Type
_scope	Scope

Returns

void

Inherited from

DartWidget._scopeMinted

---

_wireDartLifecycle()

protected _wireDartLifecycle(): void

Defined in: js-api/src/widgets/base.ts:345

Dart-owned lifecycle: the platform kill disposes the scope, and disposing the scope kills the widget through the kill-walk.

Returns

void

Inherited from

DartWidget._wireDartLifecycle

---

_wireJsLifecycle()

protected _wireJsLifecycle(): void

Defined in: js-api/src/widgets/base.ts:336

JS-owned lifecycle: disposing the scope detaches the widget, and vice versa.

Returns

void

Inherited from

DartWidget._wireJsLifecycle

---

_wireLifecycle()

protected _wireLifecycle(): void

Defined in: js-api/src/widgets/base.ts:503

Returns

void

Inherited from

DartWidget._wireLifecycle

---

accessibleLabel()

protected accessibleLabel(): string | undefined

Defined in: js-api/src/u2core/component.ts:762

The accessible name: aria-label, then the aria-labelledby texts, then this control's own data-u2-part="label" element, then — for a root that is a button — its own text.

Returns

string | undefined

Inherited from

DartWidget.accessibleLabel

---

add()

add(content): Dialog<Inputs>

Defined in: js-api/src/widgets/forms.ts:122

Adds content to the dialog. using addInput() for inputs is preferred, as it provides better type safety.

Parameters

Parameter	Type
content	HTMLElement | Widget<any> | InputBase<any>

Returns

Dialog<Inputs>

---

addButton()

addButton(text, action, index?, tooltip?): Dialog<Inputs>

Defined in: js-api/src/widgets/forms.ts:157

Adds command button with the specified text.

Parameters

Parameter	Type	Default value	Description
text	string	undefined	-
action	Callback	undefined	-
index	number	0	-
tooltip	string | null	null	-

Returns

Dialog<Inputs>

---

addContextAction()

addContextAction(text, action): Dialog<Inputs>

Defined in: js-api/src/widgets/forms.ts:163

Adds context action with the specified text.

Parameters

Parameter	Type
text	string
action	Callback

Returns

Dialog<Inputs>

---

addInput()

addInput<K, V>(caption, input): Dialog<Record<K, V> & Inputs>

Defined in: js-api/src/widgets/forms.ts:128

Adds named input, which than can be used in combo with namedInputs, to get inputs in type-safe way

Type Parameters

Type Parameter
K extends string
V extends InputBase<any>

Parameters

Parameter	Type
caption	K
input	V

Returns

Dialog<Record<K, V> & Inputs>

---

addProperty()

addProperty(propertyName, propertyType, defaultValue?, options?): any

Defined in: js-api/src/widgets/base.ts:388

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" | "bool" | "int" | "double" | "byte_array" | "datetime" | "qnum" | "dataframe" | "num" | "string_list" | "dataframe_list" | "cell" | "column" | "column_list" | "graphics" | "blob" | "tablerowfiltercall" | "colfiltercall" | "bitset" | "dynamic" | "viewer" | "list" | "semantic_value" | "func" | "funccall" | "property" | "categorical" | "numerical" | "GridCellRenderArgs" | "element" | "view" | "TableView" | "User" | "Menu" | "Project" | "event_data" | "progressindicator" | "Credentials" | "ScriptEnvironment" | "Notebook"	undefined	-
defaultValue	any	null	-
options	object & IProperty | null	null	-

Returns

any

See

Registered property gets added to properties. Returns default value, thus allowing to combine registering a property with the initialization

options.get/options.set override how the property reads/writes (instead of the default fieldName field access); the change notification (onPropertyChanged) always fires on write, and a {get}-only options yields a custom read with the default fieldName write.

Inherited from

DartWidget.addProperty

---

addStatusProvider()

addStatusProvider(name, provider): void

Defined in: js-api/src/widgets/base.ts:468

Adds live parts, hit areas and readings to this widget's status. Providers run in registration order on every read; an existing name is replaced in place, and later providers override earlier entries. Coordinates use the widget's own hit-area system. Detaching the widget removes all providers. A subclass that overrides getWidgetStatus composes with super.getWidgetStatus().

Parameters

Parameter	Type	Description
name	string	Stable name of the component contributing the status.
provider	StatusProvider	Computes the contribution each time the status is requested.

Returns

void

Example

widget.addStatusProvider('selection', () => ({values: {'selected rows': table.selection.trueCount}}));
console.log(widget.getWidgetStatus().values?.['selected rows']);
widget.removeStatusProvider('selection');
see samples/grid/custom-renderer-status

Inherited from

DartWidget.addStatusProvider

---

apply()

apply(properties): Widget

Defined in: js-api/src/widgets/base.ts:267

Sets each key of properties as the property of that name; returns this widget.

Parameters

Parameter	Type
properties	object

Returns

Widget

Inherited from

DartWidget.apply

---

awaitOnOK()

awaitOnOK<T>(handler): Promise<T>

Defined in: js-api/src/widgets/forms.ts:71

Sets the OK button handler and returns a promise of the handler callback.

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type
handler	() => Promise<T>

Returns

Promise<T>

---

bindProps()

bindProps(): BindProp[]

Defined in: js-api/src/u2core/component.ts:492

The signal-backed subset of the meta props — what a binding picker offers on a named node — plus, under propertyTier, every declared property. Allocates no signal.

Returns

BindProp[]

Inherited from

DartWidget.bindProps

---

bindStep()

bindStep(name): Signal<unknown> | BindSource | null

Defined in: js-api/src/u2core/component.ts:481

One binding step (DD5): a meta-declared prop's same-named Signal member — a named node is a bind source, generated off componentMeta the way getProperties is — then, under propertyTier, a cached signal over the declared property. '' answers the default binding: the component's own value signal, where one exists.

Parameters

Parameter	Type
name	string

Returns

Signal<unknown> | BindSource | null

Inherited from

DartWidget.bindStep

---

clear()

clear(): void

Defined in: js-api/src/widgets/forms.ts:182

Clears the content.

Returns

void

---

close()

close(): void

Defined in: js-api/src/widgets/forms.ts:145

Closes the dialog.

Returns

void

---

deriveName()

protected deriveName(x): void

Defined in: js-api/src/u2core/component.ts:109

Sets the introspection/form key without claiming an automation id — the label-fallback path: a caption is not a stable identity, so it never reaches data-u2-name.

Parameters

Parameter	Type
x	string | undefined

Returns

void

Inherited from

DartWidget.deriveName

---

detach()

detach(): void

Defined in: js-api/src/widgets/base.ts:317

Gets called when a widget is detached and will no longer be used. Typically used for unsubscribing from events. Be sure to call super.detach() if this method is overridden.

Returns

void

Inherited from

DartWidget.detach

---

dispose()

dispose(): void

Defined in: js-api/src/u2core/component.ts:687

Disposes the control; disposed by hand, it also leaves the page — a dead control left on show looks alive. One its owner disposes leaves the DOM to whoever holds it: a region swapping its content, a spec re-rendering.

Returns

void

Inherited from

DartWidget.dispose

---

effect()

effect(fn): this

Defined in: js-api/src/u2core/component.ts:260

Runs fn now and on every change of the signals it reads, until this component is disposed. Called while a row of each() or an effect run is being built, it belongs on a control built there (input.effect(...)) — on a longer-lived one it piles up with every rebuild, and u2 warns.

Parameters

Parameter	Type
fn	() => void

Returns

this

Inherited from

DartWidget.effect

---

fireEvent()

protected fireEvent(eventId, args?): void

Defined in: js-api/src/u2core/component.ts:636

Every matching listener runs inside one batch; a throwing one is reported to this component's scope and does not stop the rest.

Parameters

Parameter	Type
eventId	string
args?	unknown

Returns

void

Inherited from

DartWidget.fireEvent

---

getButton()

getButton(text): HTMLButtonElement

Defined in: js-api/src/widgets/forms.ts:150

Returns command button with the specified text.

Parameters

Parameter	Type
text	string

Returns

HTMLButtonElement

---

getDartProperties()

getDartProperties(): any[]

Defined in: js-api/src/widgets/base.ts:296

Dart handles of the properties that have one.

Returns

any[]

Inherited from

DartWidget.getDartProperties

---

getFunctions()

getFunctions(): Func[]

Defined in: js-api/src/widgets/base.ts:507

Functions applicable to the Dart widget, as the context menu and the AI assistant see them.

Returns

Func[]

Inherited from

DartWidget.getFunctions

---

getItems()

getItems(_opts?): IItemsState | undefined

Defined in: js-api/src/u2core/component.ts:737

Items of a collection-like control; undefined for other kinds. list holds the first ITEMS_CAP unless all.

Parameters

Parameter	Type
_opts?	{ all?: boolean; }
_opts.all?	boolean

Returns

IItemsState | undefined

Inherited from

DartWidget.getItems

---

getProperties()

getProperties(): Property[]

Defined in: js-api/src/widgets/base.ts:505

Properties of the Dart widget.

Returns

Property[]

Inherited from

DartWidget.getProperties

---

getState()

getState(): IControlState

Defined in: js-api/src/u2core/component.ts:713

The state block generic tests read (DG.U2.state). This base reads the DOM — kind, name, accessible name, aria-disabled, hidden, focus, aria-busy — plus getItems; a subclass adds what the DOM cannot say and spreads super.getState(). Synchronous, side-effect free, never cached.

Returns

IControlState

Inherited from

DartWidget.getState

---

getWidgetStatus()

getWidgetStatus(): IWidgetStatus

Defined in: js-api/src/widgets/base.ts:432

Returns the widget's runtime structure for automated testing and introspection; state is read off the DOM (kind, label, enabled, visible, focused …), then merged with what providers contribute.

Returns

IWidgetStatus

Inherited from

DartWidget.getWidgetStatus

---

history()

history(getInput, applyInput): void

Defined in: js-api/src/widgets/forms.ts:171

Initializes the 'history' feature.

Parameters

Parameter	Type	Description
getInput	() => any	collects the input from UI into JSON-serializable object
applyInput	(x) => void	refreshes the UI according to input

Returns

void

---

initDefaultHistory()

initDefaultHistory(): Dialog<Inputs>

Defined in: js-api/src/widgets/forms.ts:176

Initializes default history.

Returns

Dialog<Inputs>

---

initFromLocalStorage()

initFromLocalStorage(): void

Defined in: js-api/src/widgets/forms.ts:192

Initializes the dialog properties from local storage.

Returns

void

---

input()

input(caption): InputBase

Defined in: js-api/src/widgets/forms.ts:55

Returns an input with the specified caption, or throws an exception.

Parameters

Parameter	Type
caption	string

Returns

InputBase

---

link()

link(name, source, twoWay): void

Defined in: js-api/src/u2core/component.ts:453

Keeps this component's name step and source equal, echo-suppressed by value; the reverse direction only where twoWay. A component that took source as its own signal needs no link and gets none; a read-only step cannot follow anything and gets none either.

Parameters

Parameter	Type
name	string
source	Signal<unknown>
twoWay	boolean

Returns

void

Inherited from

DartWidget.link

---

on()

on(eventId, handler): () => void

Defined in: js-api/src/u2core/component.ts:623

Subscribes handler to onEvent(eventId); it gets the payload and this component. Owned by the ambient scope when there is one (the subscriber's), else by this component; runs as Scope.bind runs a handler. Answers the unsubscribe.

Parameters

Parameter	Type
eventId	string
handler	(arg, source) => void

Returns

() => void

Inherited from

DartWidget.on

---

onCancel()

onCancel(handler): Dialog<Inputs>

Defined in: js-api/src/widgets/forms.ts:85

Sets the CANCEL button handler

Parameters

Parameter	Type
handler	Callback

Returns

Dialog<Inputs>

---

onEvent()

onEvent(eventId?): Observable<any>

Defined in: js-api/src/widgets/base.ts:522

The platform's events of that id only: the u2 + DOM merge of Widget.onEvent would mint a scope, and register a Dart cleanup, for every toJs wrapper subscribed through.

Parameters

Parameter	Type	Default value
eventId	string | null	null

Returns

Observable<any>

Inherited from

DartWidget.onEvent

---

onFrameAttached()

onFrameAttached(dataFrame): void

Defined in: js-api/src/widgets/base.ts:304

Called when a DataFrame is attached; override to bind data.

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Inherited from

DartWidget.onFrameAttached

---

onOK()

onOK(handler, options?): Dialog<Inputs>

Defined in: js-api/src/widgets/forms.ts:64

Sets the OK button handler, and shows the OK button

Parameters

Parameter	Type
handler	Callback
options?	{ closeOnEnter?: boolean; }
options.closeOnEnter?	boolean

Returns

Dialog<Inputs>

---

onPropertyChanged()

onPropertyChanged(property): void

Defined in: js-api/src/widgets/base.ts:293

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

DartWidget.onPropertyChanged

---

own()

own(dispose): this

Defined in: js-api/src/u2core/component.ts:267

Registers a cleanup that runs when this component is disposed.

Parameters

Parameter	Type
dispose	() => void

Returns

this

Inherited from

DartWidget.own

---

propertyChanges()

protected propertyChanges(): ObservableLike<PropertyChange>

Defined in: js-api/src/widgets/base.ts:375

What refreshes the property tier's cached signals from outside: null where nothing announces a change (one-way).

Returns

ObservableLike<PropertyChange>

Inherited from

DartWidget.propertyChanges

---

registerFunction()

protected registerFunction(f): void

Defined in: js-api/src/u2core/component.ts:616

Parameters

Parameter	Type
f	FuncLike

Returns

void

Inherited from

DartWidget.registerFunction

---

removeStatusProvider()

removeStatusProvider(name): void

Defined in: js-api/src/widgets/base.ts:477

Removes the status contribution registered under name; an absent name is a no-op.

Parameters

Parameter	Type	Description
name	string	The name passed to addStatusProvider.

Returns

void

Example

widget.removeStatusProvider('selection');
see samples/grid/custom-renderer-status

Inherited from

DartWidget.removeStatusProvider

---

revealItem()

revealItem(keyOrLabel): Promise<HTMLElement | null>

Defined in: js-api/src/u2core/component.ts:746

Brings the item into view and resolves to its element, or null when none matches: the exact key (data-u2-item) first, then the label, trimmed and case-insensitive. Several label matches reject, naming the candidates. This base searches the rendered [data-u2-item] elements under the root and in the popups it owns; a virtual or collapsible control overrides it to scroll or expand first.

Parameters

Parameter	Type
keyOrLabel	string

Returns

Promise<HTMLElement | null>

Inherited from

DartWidget.revealItem

---

runInScope()

runInScope<T>(fn): T

Defined in: js-api/src/u2core/component.ts:253

Runs fn with this component's scope ambient: what it builds is owned by this component.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
fn	() => T

Returns

T

Deprecated

Use the owner verb build(fn) (OwnerVerbs.build): this.build(fn), dialog.build(fn).

Inherited from

DartWidget.runInScope

---

show()

show(options?): Dialog<Inputs>

Defined in: js-api/src/widgets/forms.ts:110

Parameters

Parameter	Type	Description
options?	{ backgroundColor?: string; center?: boolean; centerAt?: Element; fullScreen?: boolean; height?: number; modal?: boolean; resizable?: boolean; showNextTo?: HTMLElement; width?: number; x?: number; y?: number; }	-
options.backgroundColor?	string	-
options.center?	boolean	-
options.centerAt?	Element	-
options.fullScreen?	boolean	-
options.height?	number	-
options.modal?	boolean	-
options.resizable?	boolean	-
options.showNextTo?	HTMLElement	-
options.width?	number	-
options.x?	number	-
options.y?	number	-

Returns

Dialog<Inputs>

---

showModal()

showModal(fullScreen): Dialog<Inputs>

Defined in: js-api/src/widgets/forms.ts:116

Parameters

Parameter	Type
fullScreen	boolean

Returns

Dialog<Inputs>

---

sourceRowsChanged()

sourceRowsChanged(): void

Defined in: js-api/src/widgets/base.ts:301

Called when the rows the widget shows change; override to refresh.

Returns

void

Inherited from

DartWidget.sourceRowsChanged

---

sub()

sub(subscription): void

Defined in: js-api/src/widgets/base.ts:261

Registers a subscription to an external event.

Parameters

Parameter	Type
subscription	Subscription

Returns

void

Inherited from

DartWidget.sub

---

subscribe()

subscribe<T>(source, handler): () => void

Defined in: js-api/src/u2core/component.ts:1040

Subscribes handler to source until this owner is disposed. See Scope.subscribe.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
source	ObservableLike<T>
handler	(value) => void

Returns

() => void

Inherited from

OwnerVerbs.subscribe

---

task()

task<R>(fn, options?): TaskRun

Defined in: js-api/src/u2core/component.ts:1038

Async work owned here. See Scope.task.

Type Parameters

Type Parameter
R

Parameters

Parameter	Type
fn	(t) => R | PromiseLike<R>
options?	TaskOptions

Returns

TaskRun

Inherited from

OwnerVerbs.task

---

toDart()

toDart(): any

Defined in: js-api/src/widgets/base.ts:254

The Dart handle of this widget, created on first use.

Returns

any

Inherited from

DartWidget.toDart

---

_isPlain()

protected static _isPlain(x): x is Record<string, unknown>

Defined in: js-api/src/u2core/component.ts:244

Parameters

Parameter	Type
x	unknown

Returns

x is Record<string, unknown>

Inherited from

DartWidget._isPlain

---

build()

Call Signature

static build(builder, options?): Control

Defined in: js-api/src/u2core/component.ts:943

The function component component makes, under its old name.

Parameters

Parameter	Type
builder	(self) => BuiltRoot
options?	ControlBuildOptions

Returns

Control

Deprecated

Use component: one spelling, apart from an owner's build(fn).

Inherited from

DartWidget.build

Call Signature

static build<R>(builder, options?): never

Defined in: js-api/src/u2core/component.ts:944

The function component component makes, under its old name.

Type Parameters

Type Parameter
R extends BuiltHandle

Parameters

Parameter	Type
builder	(self) => R
options?	ControlBuildOptions

Returns

never

Deprecated

Use component: one spelling, apart from an owner's build(fn).

Inherited from

DartWidget.build

---

create()

static create(options?): Dialog

Defined in: js-api/src/widgets/forms.ts:36

Creates a new dialog with the specified options.

Parameters

Parameter	Type
options?	string | { helpUrl?: string; showFooter?: boolean; showHeader?: boolean; title?: string; }

Returns

Dialog

---

find()

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

Defined in: js-api/src/widgets/base.ts:243

Finds existing widget from its visual root.

Parameters

Parameter	Type
root	Element

Returns

Widget<any> | null

Inherited from

DartWidget.find

---

forElement()

static forElement(el): Control | undefined

Defined in: js-api/src/u2core/component.ts:904

The nearest control owning el — the DOM → component door for tooling, automation and inspectors (the u2 counterpart of the platform's Widget.find): the nearest root at or above el, else, inside a popup portaled to the body, the popup's owner (data-u2-owner-id). Best-effort: the last control constructed on (or assigned) a root wins it. The root carries the control under Symbol.for('u2.control'), so every engine copy on the page answers alike.

Parameters

Parameter	Type
el	Element | null

Returns

Control | undefined

Inherited from

DartWidget.forElement

---

fromRoot()

static fromRoot(root): Widget

Defined in: js-api/src/widgets/base.ts:483

Creates a new widget from the root element.

Parameters

Parameter	Type
root	HTMLElement

Returns

Widget

Inherited from

DartWidget.fromRoot

---

getAll()

static getAll(): Widget<any>[]

Defined in: js-api/src/widgets/base.ts:238

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

DartWidget.getAll

---

getOpenDialogs()

static getOpenDialogs(): Dialog<{ }>[]

Defined in: js-api/src/widgets/forms.ts:187

Returns currently open dialogs.

Returns

Dialog<{ }>[]

---

init()

static init(self, scope?): void

Defined in: js-api/src/u2core/component.ts:126

Per-instance state, for a constructed component and for an adopted platform object alike.

Parameters

Parameter	Type
self	Component
scope?	Scope

Returns

void

Inherited from

DartWidget.init

---

is()

static is(x): x is Control

Defined in: js-api/src/u2core/component.ts:915

Structural probe by methods only — never .scope: the accessor mints.

Parameters

Parameter	Type
x	unknown

Returns

x is Control

Inherited from

DartWidget.is

---

jsonValue()

static jsonValue(x, depth?): JsonValue | undefined

Defined in: js-api/src/u2core/component.ts:826

The JSON-safe projection behind IControlState.value: a Date → its ISO string, an object with a string name (an entity, a column) → the name, arrays and sets element-wise, plain objects key-wise (depth 4), a signal → its current value; functions and elements → undefined; anything else → String(x).

Parameters

Parameter	Type	Default value
x	unknown	undefined
depth	number	0

Returns

JsonValue | undefined

Inherited from

DartWidget.jsonValue

---

labelOf()

protected static labelOf(el): string | undefined

Defined in: js-api/src/u2core/component.ts:775

aria-label, else the joined texts of the aria-labelledby elements; undefined when neither names el.

Parameters

Parameter	Type
el	Element

Returns

string | undefined

Inherited from

DartWidget.labelOf

---

registerCleanup()

static registerCleanup(element, cleanup): void

Defined in: js-api/src/widgets/base.ts:249

Registers a cleanup function to run when [element] is killed — i.e. when its host view or pane closes. Also marks the element so the kill-walk can find it.

Parameters

Parameter	Type
element	Element
cleanup	Callback

Returns

void

Inherited from

DartWidget.registerCleanup

---

sameValue()

static sameValue(a, b): boolean

Defined in: js-api/src/u2core/component.ts:232

The equality the property tier and link suppress echoes by: Object.is, arrays element-wise, plain objects key-wise (recursive), everything else by identity.

Parameters

Parameter	Type
a	unknown
b	unknown

Returns

boolean

Inherited from

DartWidget.sameValue

---

text()

protected static text(el): string

Defined in: js-api/src/u2core/component.ts:789

The text the user reads: trimmed, single-spaced.

Parameters

Parameter	Type
el	Element

Returns

string

Inherited from

DartWidget.text