Wizard

Defined in: src/ui/wizard.ts:26

EXPERIMENTAL - USE AT YOUR OWN RISK - API might change

Extends

• Dialog

Constructors

Constructor

new Wizard(options?): Wizard

Defined in: src/ui/wizard.ts:36

Parameters

Parameter	Type
options?	{ helpUrl?: string; title?: string; }
options.helpUrl?	string
options.title?	string

Returns

Wizard

Overrides

Dialog.constructor

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
_currentPage	public	WizardPage	undefined	-	-	src/ui/wizard.ts:31
_functions	protected	Func[]	[]	-	Widget._functions	src/widgets/base.ts:243
_properties	protected	Property[]	[]	-	Widget._properties	src/widgets/base.ts:242
_root	protected	HTMLElement	undefined	-	Widget._root	src/widgets/base.ts:241
captionHost	public	HTMLDivElement	undefined	-	-	src/ui/wizard.ts:27
contentHost	public	HTMLDivElement	undefined	-	-	src/ui/wizard.ts:28
dart	public	any	undefined	-	Widget.dart	src/widgets/base.ts:246
factory	public	Func | null	null	Constructor function. No parameters, returns [Widget].	Widget.factory	src/widgets/base.ts:239
isDetached	public	boolean	false	-	Widget.isDetached	src/widgets/base.ts:247
nextButton	public	Dialog<{ }>	undefined	-	-	src/ui/wizard.ts:34
okButton	public	HTMLButtonElement	undefined	-	-	src/ui/wizard.ts:32
pages	public	WizardPage[]	[]	-	-	src/ui/wizard.ts:30
prevButton	public	Dialog<{ }>	undefined	-	-	src/ui/wizard.ts:33
props	public	any	undefined	-	Dialog.props	src/widgets/base.ts:244
subs	public	Subscription[]	undefined	-	Widget.subs	src/widgets/base.ts:245
temp	public	any	undefined	Contains auxiliary information	Widget.temp	src/widgets/base.ts:236
wizardRoot	public	HTMLDivElement	undefined	-	-	src/ui/wizard.ts:29

Accessors

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

Widget.children

---

completable

Get Signature

get completable(): boolean

Defined in: src/ui/wizard.ts:51

Returns

boolean

---

currentPage

Get Signature

get currentPage(): WizardPage

Defined in: src/ui/wizard.ts:56

Returns

WizardPage

Set Signature

set currentPage(w): void

Defined in: src/ui/wizard.ts:57

Parameters

Parameter	Type
w	WizardPage

Returns

void

---

helpUrl

Get Signature

get helpUrl(): string

Defined in: 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: src/widgets/forms.ts:45

Parameters

Parameter	Type
url	string

Returns

void

Inherited from

Dialog.helpUrl

---

inputs

Get Signature

get inputs(): InputBase<any>[]

Defined in: src/widgets/forms.ts:52

Returns a list of the dialog's inputs.

Returns

InputBase<any>[]

Inherited from

Dialog.inputs

---

namedInputs

Get Signature

get namedInputs(): Inputs

Defined in: src/widgets/forms.ts:137

gets typed inputs with captions as keys.

Returns

Inputs

Inherited from

Dialog.namedInputs

---

onClose

Get Signature

get onClose(): Observable<any>

Defined in: src/widgets/forms.ts:98

Returns

Observable<any>

Inherited from

Dialog.onClose

---

pageIndex

Get Signature

get pageIndex(): number

Defined in: src/ui/wizard.ts:49

Returns

number

---

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

Widget.parent

---

root

Get Signature

get root(): HTMLElement

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

Widget's visual root.

Returns

HTMLElement

Inherited from

Dialog.root

---

title

Get Signature

get title(): string

Defined in: src/widgets/forms.ts:48

Returns the title of a dialog.

Returns

string

Set Signature

set title(t): void

Defined in: src/widgets/forms.ts:49

Parameters

Parameter	Type
t	string

Returns

void

Inherited from

Dialog.title

---

type

Get Signature

get type(): string

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

Returns

string

Inherited from

Dialog.type

Methods

_updateButtonStates()

_updateButtonStates(): void

Defined in: src/ui/wizard.ts:68

Returns

void

---

add()

add(content): Dialog<{ }>

Defined in: src/widgets/forms.ts:124

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<{ }>

Inherited from

Dialog.add

---

addButton()

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

Defined in: src/widgets/forms.ts:166

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<{ }>

Inherited from

Dialog.addButton

---

addContextAction()

addContextAction(text, action): Dialog<{ }>

Defined in: src/widgets/forms.ts:176

Adds context action with the specified text.

Parameters

Parameter	Type	Description
text	string	-
action	Function	-

Returns

Dialog<{ }>

Inherited from

Dialog.addContextAction

---

addInput()

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

Defined in: src/widgets/forms.ts:130

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

Inherited from

Dialog.addInput

---

apply()

apply(properties): Widget

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

Parameters

Parameter	Type	Description
properties	object	-

Returns

Widget

Inherited from

Dialog.apply

---

awaitOnOK()

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

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

Inherited from

Dialog.awaitOnOK

---

clear()

clear(): void

Defined in: src/widgets/forms.ts:196

Clears the content.

Returns

void

Inherited from

Dialog.clear

---

close()

close(): void

Defined in: src/widgets/forms.ts:147

Closes the dialog.

Returns

void

Inherited from

Dialog.close

---

detach()

detach(): void

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

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

Dialog.detach

---

getButton()

getButton(text): HTMLButtonElement

Defined in: src/widgets/forms.ts:155

Returns command button with the specified text.

Parameters

Parameter	Type	Description
text	string	-

Returns

HTMLButtonElement

Inherited from

Dialog.getButton

---

getDartProperties()

getDartProperties(): any[]

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

Returns

any[]

Inherited from

Dialog.getDartProperties

---

getFunctions()

getFunctions(): Func[]

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

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

Dialog.getFunctions

---

getProperties()

getProperties(): Property[]

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

Returns all properties of this widget.

Returns

Property[]

Inherited from

Dialog.getProperties

---

getWidgetStatus()

getWidgetStatus(): IWidgetStatus

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

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

Returns

IWidgetStatus

Inherited from

Dialog.getWidgetStatus

---

history()

history(getInput, applyInput): void

Defined in: src/widgets/forms.ts:185

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

Inherited from

Dialog.history

---

initDefaultHistory()

initDefaultHistory(): Dialog<{ }>

Defined in: src/widgets/forms.ts:190

Initializes default history.

Returns

Dialog<{ }>

Inherited from

Dialog.initDefaultHistory

---

initFromLocalStorage()

initFromLocalStorage(): void

Defined in: src/widgets/forms.ts:206

Initializes the dialog properties from local storage.

Returns

void

Inherited from

Dialog.initFromLocalStorage

---

input()

input(caption): InputBase

Defined in: src/widgets/forms.ts:55

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

Parameters

Parameter	Type
caption	string

Returns

InputBase

Inherited from

Dialog.input

---

next()

next(): void

Defined in: src/ui/wizard.ts:81

Activates the previous page

Returns

void

---

onCancel()

onCancel(handler): Dialog<{ }>

Defined in: src/widgets/forms.ts:92

Sets the CANCEL button handler

Parameters

Parameter	Type	Description
handler	Function	-

Returns

Dialog<{ }>

Inherited from

Dialog.onCancel

---

onEvent()

onEvent(eventId?): Observable<any>

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

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

Dialog.onEvent

---

onFrameAttached()

onFrameAttached(dataFrame): void

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

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Inherited from

Dialog.onFrameAttached

---

onOK()

onOK(handler, options?): Dialog<{ }>

Defined in: 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<{ }>

Inherited from

Dialog.onOK

---

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

Dialog.onPropertyChanged

---

page()

page(p): Wizard

Defined in: src/ui/wizard.ts:41

Parameters

Parameter	Type
p	WizardPage

Returns

Wizard

---

prev()

prev(): void

Defined in: src/ui/wizard.ts:75

Activates the previous page

Returns

void

---

show()

show(options?): Dialog<{ }>

Defined in: src/widgets/forms.ts:109

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<{ }>

Inherited from

Dialog.show

---

showModal()

showModal(fullScreen): Dialog<{ }>

Defined in: src/widgets/forms.ts:116

Parameters

Parameter	Type	Description
fullScreen	boolean	-

Returns

Dialog<{ }>

Inherited from

Dialog.showModal

---

sourceRowsChanged()

sourceRowsChanged(): void

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

Returns

void

Inherited from

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

Dialog.sub

---

toDart()

toDart(): any

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

Returns

any

Inherited from

Dialog.toDart

---

create()

static create(options?): Dialog

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

Inherited from

Dialog.create

---

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

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

Dialog.fromRoot

---

getAll()

static getAll(): Widget<any>[]

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

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

Dialog.getAll

---

getOpenDialogs()

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

Defined in: src/widgets/forms.ts:201

Returns currently open dialogs.

Returns

Dialog<{ }>[]

Inherited from

Dialog.getOpenDialogs