Dialog<Inputs>

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

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

Example

ui.dialog('Windows')
  .add(ui.)
  .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:277
_properties	protected	Property[]	[]	-	DartWidget._properties	js-api/src/widgets/base.ts:276
_root	protected	HTMLElement	undefined	-	DartWidget._root	js-api/src/widgets/base.ts:275
dart	public	any	undefined	-	DartWidget.dart	js-api/src/widgets/base.ts:280
factory	public	Func | null	null	Constructor function. No parameters, returns [Widget].	DartWidget.factory	js-api/src/widgets/base.ts:273
isDetached	public	boolean	false	-	DartWidget.isDetached	js-api/src/widgets/base.ts:281
props	public	any	undefined	-	DartWidget.props	js-api/src/widgets/base.ts:278
subs	public	Subscription[]	undefined	-	DartWidget.subs	js-api/src/widgets/base.ts:279
temp	public	any	undefined	Contains auxiliary information	DartWidget.temp	js-api/src/widgets/base.ts:270

Accessors

aiDescription

Get Signature

get aiDescription(): string | null

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

AI briefing of the underlying Dart widget.

Returns

string | null

Set Signature

set aiDescription(x): void

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

A short AI-facing briefing: what this widget is, what its functions do, and how the assistant should approach it (e.g. which getFunctions entries to call first). Shown to the AI assistant as part of the workspace context.

Parameters

Parameter	Type
x	string | null

Returns

void

Inherited from

DartWidget.aiDescription

---

children

Get Signature

get children(): Widget<any>[]

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

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>[]

---

namedInputs

Get Signature

get namedInputs(): Inputs

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

gets typed inputs with captions as keys.

Returns

Inputs

---

onAfterOK

Get Signature

get onAfterOK(): Observable<any>

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

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

Fires before the OK handler runs.

Returns

Observable<any>

---

onClose

Get Signature

get onClose(): Observable<any>

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

Returns

Observable<any>

---

onSaveHistoryRequest

Get Signature

get onSaveHistoryRequest(): Observable<any>

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

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

Parent widget up the DOM tree, or null.

Returns

Widget<any> | null

Inherited from

DartWidget.parent

---

root

Get Signature

get root(): HTMLElement

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

Widget's visual root.

Returns

HTMLElement

Inherited from

DartWidget.root

---

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

Returns

string

Inherited from

DartWidget.type

Methods

add()

add(content): Dialog<Inputs>

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

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

Parameters

Parameter	Type	Description
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:175

Adds command button with the specified text.

Parameters

Parameter	Type	Default value	Description
text	string	undefined	-
action	Function	undefined	-
index	number	0	-
tooltip	any	null	-

Returns

Dialog<Inputs>

---

addContextAction()

addContextAction(text, action): Dialog<Inputs>

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

Adds context action with the specified text.

Parameters

Parameter	Type	Description
text	string	-
action	Function	-

Returns

Dialog<Inputs>

---

addInput()

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

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

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>

---

apply()

apply(properties): Widget

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

Parameters

Parameter	Type	Description
properties	object	-

Returns

Widget

Inherited from

DartWidget.apply

---

awaitOnOK()

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

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

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

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type	Description
handler	() => Promise<T>	-

Returns

Promise<T>

---

clear()

clear(): void

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

Clears the content.

Returns

void

---

close()

close(): void

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

Closes the dialog.

Returns

void

---

detach()

detach(): void

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

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

---

getButton()

getButton(text): HTMLButtonElement

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

Returns command button with the specified text.

Parameters

Parameter	Type	Description
text	string	-

Returns

HTMLButtonElement

---

getDartProperties()

getDartProperties(): any[]

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

Returns

any[]

Inherited from

DartWidget.getDartProperties

---

getFunctions()

getFunctions(): Func[]

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

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

DartWidget.getFunctions

---

getProperties()

getProperties(): Property[]

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

Returns all properties of this widget.

Returns

Property[]

Inherited from

DartWidget.getProperties

---

getWidgetStatus()

getWidgetStatus(): IWidgetStatus

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

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

Returns

IWidgetStatus

Inherited from

DartWidget.getWidgetStatus

---

history()

history(getInput, applyInput): void

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

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

Initializes default history.

Returns

Dialog<Inputs>

---

initFromLocalStorage()

initFromLocalStorage(): void

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

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

---

onCancel()

onCancel(handler): Dialog<Inputs>

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

Sets the CANCEL button handler

Parameters

Parameter	Type	Description
handler	Function	-

Returns

Dialog<Inputs>

---

onEvent()

onEvent(eventId?): Observable<any>

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

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

DartWidget.onEvent

---

onFrameAttached()

onFrameAttached(dataFrame): void

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

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

Sets the OK button handler, and shows the OK button

Parameters

Parameter	Type	Description
handler	Function	-
options?	{ closeOnEnter?: boolean; }	-
options.closeOnEnter?	boolean	-

Returns

Dialog<Inputs>

---

onPropertyChanged()

onPropertyChanged(property): void

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

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

---

show()

show(options?): Dialog<Inputs>

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

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

Parameters

Parameter	Type	Description
fullScreen	boolean	-

Returns

Dialog<Inputs>

---

sourceRowsChanged()

sourceRowsChanged(): void

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

Returns

void

Inherited from

DartWidget.sourceRowsChanged

---

sub()

sub(subscription): void

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

Registers a subscription to an external event.

Parameters

Parameter	Type	Description
subscription	Subscription	-

Returns

void

Inherited from

DartWidget.sub

---

toDart()

toDart(): any

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

Returns

any

Inherited from

DartWidget.toDart

---

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

Finds existing widget from its visual root.

Parameters

Parameter	Type
root	Element

Returns

Widget<any> | null

Inherited from

DartWidget.find

---

fromRoot()

static fromRoot(root): Widget

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

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

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

DartWidget.getAll

---

getOpenDialogs()

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

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

Returns currently open dialogs.

Returns

Dialog<{ }>[]