au-widget-pim-options/au-widget-pim-options

Classes

AuWidgetPimOptions

Declares methods used to retrieve the selected value in a widget and clear the selection.

Extends

• AuBaseSelectorWidget

Constructors

Constructor

new AuWidgetPimOptions(): AuWidgetPimOptions;

Returns

AuWidgetPimOptions

Inherited from

AuBaseSelectorWidget.constructor

Properties

isLoading

isLoading: boolean = false;

options

options: any[] = [];

params

params: any;

Compiled widget configuration.

Inherited from

AuBaseSelectorWidget.params

Accessors

_

Get Signature

get _(): [] | Record<string, number | number[]>;

Returns the selected item.

Returns

[] | Record<string, number | number[]>

Overrides

AuBaseSelectorWidget._

summary

Get Signature

get summary(): any;

Returns

any

Methods

checkInitDependenciesWidgets()

checkInitDependenciesWidgets(): string[];

Returns an array of widget names, due to which the current widget cannot receive parameters.

Returns

string[]

Inherited from

AuBaseSelectorWidget.checkInitDependenciesWidgets

checkOptionsLoading()

checkOptionsLoading(): void;

Returns

void

clearSelection()

clearSelection(): void;

Clears the selection.

Returns

void

Overrides

AuBaseSelectorWidget.clearSelection

resetPreloaderState()

resetPreloaderState(): void;

Returns

void

Inherited from

AuBaseSelectorWidget.resetPreloaderState

showPreloader()

showPreloader(
   isPreload, 
   message?, 
   timeout?): void;

Shows a preloader.

"onClick": [
  "{{#function main.showPreloader(true, 'Creating print files...')}}",
  "{{#function $['editor'].getHiResImages(800,800)}}",
  "{{#function main.showPreloader(false)}}"
]

Parameters

Parameter	Type	Default value	Description
isPreload	boolean	undefined	If true, enables the preloader.
message	string | string[]	...	A text message that appears next to the preloader.
timeout	number	5	-

Returns

void

Inherited from

AuBaseSelectorWidget.showPreloader

showToast()

showToast(data?, duration?): void;

Shows a toast.

return editor.loadUserInfo(data)
    .catch(err => {
        this.widget.showToast("Error: Invalid data");
        console.log(err);
    });

Parameters

Parameter	Type	Description
data?	string	A string message to display in the toast.
duration?	number	Defines how long to show the toast for.

Returns

void

Inherited from

AuBaseSelectorWidget.showToast

References

widget

Renames and re-exports AuWidgetPimOptions