Class: Wizard
dg.Wizard
EXPERIMENTAL - USE AT YOUR OWN RISK - API might change
Hierarchy
↳
Wizard
Constructors
constructor
• new Wizard(options?)
Parameters
| Name | Type |
|---|---|
options? | Object |
options.helpUrl? | string |
options.title? | string |
Overrides
Defined in
Properties
_currentPage
• _currentPage: WizardPage
Defined in
_properties
• Protected _properties: Property[]
Inherited from
Defined in
_root
• Protected _root: HTMLElement
Inherited from
Defined in
captionHost
• captionHost: HTMLDivElement
Defined in
contentHost
• contentHost: HTMLDivElement
Defined in
dart
• dart: any
Inherited from
Defined in
factory
• factory: null | Func = null
Constructor function. No parameters, returns [Widget].
Inherited from
Defined in
isDetached
• isDetached: boolean = false
Inherited from
Defined in
nextButton
• nextButton: Dialog
Defined in
okButton
• okButton: HTMLButtonElement
Defined in
pages
• pages: WizardPage[] = []
Defined in
prevButton
• prevButton: Dialog
Defined in
props
• props: any
Inherited from
Defined in
subs
• subs: Subscription[]
Inherited from
Defined in
temp
• temp: any
Contains auxiliary information
Inherited from
Defined in
wizardRoot
• wizardRoot: HTMLDivElement
Defined in
Accessors
completable
• get completable(): boolean
Returns
boolean
Defined in
currentPage
• get currentPage(): WizardPage
Returns
Defined in
• set currentPage(w): void
Parameters
| Name | Type |
|---|---|
w | WizardPage |
Returns
void
Defined in
helpUrl
• get helpUrl(): string
When provided, adds a "?" icon to the dialog header on the right.
Returns
string
Inherited from
Dialog.helpUrl
Defined in
• set helpUrl(url): void
Parameters
| Name | Type |
|---|---|
url | string |
Returns
void
Inherited from
Dialog.helpUrl
Defined in
inputs
• get inputs(): InputBase<any>[]
Returns a list of the dialog's inputs.
Returns
InputBase<any>[]
Inherited from
Dialog.inputs
Defined in
onClose
• get onClose(): Observable<any>
Returns
Observable<any>
Inherited from
Dialog.onClose
Defined in
pageIndex
• get pageIndex(): number
Returns
number
Defined in
root
• get root(): HTMLElement
Widget's visual root.
Returns
HTMLElement
Inherited from
Dialog.root
Defined in
title
• get title(): string
Returns the title of a dialog.
Returns
string
Inherited from
Dialog.title
Defined in
• set title(t): void
Parameters
| Name | Type |
|---|---|
t | string |
Returns
void
Inherited from
Dialog.title
Defined in
type
• get type(): string
Returns
string
Inherited from
Dialog.type
Defined in
Methods
_updateButtonStates
▸ _updateButtonStates(): void
Returns
void
Defined in
add
▸ add(content): Dialog
Adds content to the dialog.
Parameters
| Name | Type |
|---|---|
content | HTMLElement | Widget<any> | InputBase<any> |
Returns
Inherited from
Defined in
addButton
▸ addButton(text, action, index?, tooltip?): Dialog
Adds command button with the specified text.
Parameters
| Name | Type | Default value |
|---|---|---|
text | string | undefined |
action | Function | undefined |
index | number | 0 |
tooltip | any | null |
Returns
Inherited from
Defined in
addContextAction
▸ addContextAction(text, action): Dialog
Adds context action with the specified text.
Parameters
| Name | Type |
|---|---|
text | string |
action | Function |
Returns
Inherited from
Defined in
addProperty
▸ Private addProperty(propertyName, propertyType, defaultValue?, options?): any
Registers an property with the specified type, name, and defaultValue. Registered property gets added to {@see properties}. Returns default value, thus allowing to combine registering a property with the initialization
Parameters
| Name | Type | Default value |
|---|---|---|
propertyName | string | undefined |
propertyType | "string" | "bigint" | "object" | "map" | "file" | "view" | "element" | "int" | "double" | "bool" | "byte_array" | "datetime" | "qnum" | "dataframe" | "num" | "string_list" | "dataframe_list" | "cell" | "column" | "column_list" | "graphics" | "tablerowfiltercall" | "colfiltercall" | "bitset" | "dynamic" | "viewer" | "list" | "semantic_value" | "func" | "funccall" | "property" | "categorical" | "numerical" | "GridCellRenderArgs" | "TableView" | "User" | "Menu" | "Project" | "event_data" | "progressindicator" | "Credentials" | "ScriptEnvironment" | "Notebook" | undefined |
defaultValue | any | null |
options | null | { [key: string]: any; } & PropertyOptions | null |
Returns
any
Inherited from
Defined in
apply
▸ apply(properties): Widget<any>
Parameters
| Name | Type |
|---|---|
properties | object |
Returns
Widget<any>
Inherited from
Defined in
clear
▸ clear(): void
Clears the content.
Returns
void
Inherited from
Defined in
close
▸ close(): void
Closes the dialog.
Returns
void
Inherited from
Defined in
detach
▸ detach(): void
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
Defined in
getButton
▸ getButton(text): HTMLButtonElement
Returns command button with the specified text.
Parameters
| Name | Type |
|---|---|
text | string |
Returns
HTMLButtonElement
Inherited from
Defined in
getDartProperties
▸ getDartProperties(): any[]
Returns
any[]
Inherited from
Defined in
getProperties
▸ getProperties(): Property[]
Returns
Property[]
Inherited from
Defined in
history
▸ history(getInput, applyInput): void
Initializes the 'history' feature.
Parameters
| Name | Type | Description |
|---|---|---|
getInput | () => any | collects the input from UI into JSON-serializable object |
applyInput | (x: any) => void | refreshes the UI according to input |
Returns
void
Inherited from
Defined in
initDefaultHistory
▸ initDefaultHistory(): Dialog
Initializes default history.
Returns
Inherited from
Defined in
input
▸ input(caption): InputBase<any>
Returns an input with the specified caption, or throws an exception.
Parameters
| Name | Type |
|---|---|
caption | string |
Returns
InputBase<any>
Inherited from
Defined in
next
▸ next(): void
Activates the previous page
Returns
void
Defined in
onCancel
▸ onCancel(handler): Dialog
Sets the CANCEL button handler
Parameters
| Name | Type |
|---|---|
handler | Function |
Returns
Inherited from
Defined in
onFrameAttached
▸ onFrameAttached(dataFrame): void
Parameters
| Name | Type |
|---|---|
dataFrame | DataFrame |
Returns
void
Inherited from
Defined in
onOK
▸ onOK(handler): Dialog
Sets the OK button handler, and shows the OK button
Parameters
| Name | Type |
|---|---|
handler | Function |
Returns
Inherited from
Defined in
onPropertyChanged
▸ onPropertyChanged(property): void
Gets called when viewer's property is changed.
Parameters
| Name | Type | Description |
|---|---|---|
property | null | Property | or null, if multiple properties were changed. |
Returns
void
Inherited from
Defined in
page
▸ page(p): Wizard
Parameters
| Name | Type |
|---|---|
p | WizardPage |
Returns
Defined in
prev
▸ prev(): void
Activates the previous page
Returns
void
Defined in
show
▸ show(options?): Dialog
Parameters
| Name | Type |
|---|---|
options? | Object |
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
Inherited from
Defined in
showModal
▸ showModal(fullScreen): Dialog
Parameters
| Name | Type |
|---|---|
fullScreen | boolean |
Returns
Inherited from
Defined in
sourceRowsChanged
▸ sourceRowsChanged(): void
Returns
void
Inherited from
Defined in
sub
▸ sub(subscription): void
Registers a subscription to an external event.
Parameters
| Name | Type |
|---|---|
subscription | Subscription |
Returns
void
Inherited from
Defined in
toDart
▸ toDart(): any
Returns
any
Inherited from
Defined in
create
▸ Static create(options?): Dialog
Creates a new dialog with the specified options.
Parameters
| Name | Type |
|---|---|
options? | string | { helpUrl?: string ; showFooter?: boolean ; showHeader?: boolean ; title?: string } |
Returns
Inherited from
Defined in
find
▸ Static find(root): null | Widget<any>
Finds existing widget from its visual root.
Parameters
| Name | Type |
|---|---|
root | Element |
Returns
null | Widget<any>
Inherited from
Defined in
fromRoot
▸ Static fromRoot(root): Widget<any>
Creates a new widget from the root element.
Parameters
| Name | Type |
|---|---|
root | HTMLElement |
Returns
Widget<any>
Inherited from
Defined in
getAll
▸ Static getAll(): Widget<any>[]
Returns all currently active widgets.
Returns
Widget<any>[]
Inherited from
Defined in
getOpenDialogs
▸ Static getOpenDialogs(): Dialog[]
Returns currently open dialogs.
Returns
Dialog[]