au-widget-design-editor/AuDesignEditor

Classes

abstract AuDesignEditor

The base class for the DesignEditor widget.

Extends

• AuBaseWidget

Extended by

• AuWidgetDesignEditor

Constructors

Constructor

new AuDesignEditor(): AuDesignEditor;

Returns

AuDesignEditor

Inherited from

AuBaseWidget.constructor

Properties

params

params: any;

Compiled widget configuration.

Inherited from

AuBaseWidget.params

Methods

checkInitDependenciesWidgets()

checkInitDependenciesWidgets(): string[];

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

Returns

string[]

Inherited from

AuBaseWidget.checkInitDependenciesWidgets

colorToHex()

colorToHex(color): Promise<string>;

Parameters

Parameter	Type
color	Color

Returns

Promise<string>

getDesignEditorItemModel()

getDesignEditorItemModel(item): Promise<DesignEditorItemChanges>;

Parameters

Parameter	Type
item	any

Returns

Promise<DesignEditorItemChanges>

getEditor()

getEditor(): Promise<Editor>;

Returns a promise with an instance of the DesignEditor.

Returns

Promise<Editor>

getProduct()

getProduct(): Promise<Product>;

Returns a promise with the product opened in the DesignEditor.

Returns

Promise<Product>

resetPreloaderState()

resetPreloaderState(): void;

Returns

void

Inherited from

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

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

AuBaseWidget.showToast