TrophyCustomer's Canvas is honored with a 2020 InterTech Technology Award! Learn more 

Class: AuWidgetDesignAtoms

Hierarchy

AuBaseWidget

AuWidgetDesignAtoms

Implements

Index

Properties

Accessors

Methods

Properties

params

params: IDesignAtomsWidgetConfig

Overrides AuBaseWidget.params


paramsRaw

paramsRaw: any

Inherited from AuBaseWidget.paramsRaw

Uncompiled widget configuration.

Accessors

currentSurface

get currentSurface(): Surface‹›

Returns:Surface‹›


hiResUrls

get hiResUrls(): string[]

Returns:string[]


productModel

get productModel(): Product‹›

Returns:Product‹›

set productModel(product: Product): void

Parameters:

Name Type
product Product

Returns:void


proofImageUrls

get proofImageUrls(): string[]

Returns:string[]


selectedItems

get selectedItems(): Item‹›[]

Returns:Item‹›[]


viewer

get viewer(): Viewer‹›

Returns:Viewer‹›

set viewer(viewer: Viewer): void

Parameters:

Name Type
viewer Viewer

Returns:void

Methods

addCustomStyles

addCustomStyles(params: any): void

Inherited from AuBaseWidget.addCustomStyles

Applies new styles to a widget.

Parameters:

Name Type
params any

Returns:void


checkInitDependenciesWidgets

checkInitDependenciesWidgets(): string[]

Inherited from AuBaseWidget.checkInitDependenciesWidgets

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

Returns:string[]


compile

compile(additionalParam: any): Promise‹any›

Inherited from AuBaseWidget.compile

Compiles the widget config.

"steps": [{
  "name": "card-size",
  "title": "Step 1. Card Options",
  "description": "Choose a card size.",
  "toolPanel": {
    "name": "options"
  },
  "onActivate": [
    "{{#function $['logo'].compile() }}"
  ]
},
...

Parameters:

Name Type Default Description
additionalParam any Parameters for widget config compilation.

Returns:Promise‹any›

The compiled widget configuration.


emitChange

emitChange(data: any, forceRecompile: boolean): void

Inherited from AuBaseWidget.emitChange

Sends a message about the widget state changes.

"steps": [{
  "name": "card-size",
  "title": "Step 1. Card Options",
  "description": "Choose a card size.",
  "toolPanel": {
    "name": "options"
  },
  "onActivate": [
    "{{#function $['options'].emitChange()}}"
  ]
},
...

Parameters:

Name Type Default Description
data any Data for updating the widget.
forceRecompile boolean false If true, runs widget recompilation to apply the updated parameters.

Returns:void


getHiResImages

getHiResImages(): Promise‹string[]›

Returns:Promise‹string[]›


getProofImages

getProofImages(): Promise‹string[]›

Returns:Promise‹string[]›


getSerializedProduct

getSerializedProduct(): string

Returns:string


resizeSelectedImages

resizeSelectedImages(resizeMode: ResizeMode, targetSize?: SizeF): void

Parameters:

Name Type
resizeMode ResizeMode
targetSize? SizeF

Returns:void


rotateSelectedItems

rotateSelectedItems(angle: number): void

Parameters:

Name Type Default
angle number 90

Returns:void


showPreloader

showPreloader(isPreload: boolean, message: string): void

Inherited from AuBaseWidget.showPreloader

Shows a preloader.

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

Parameters:

Name Type Default Description
isPreload boolean - If true, enables the preloader.
message string undefined A text message that appears next to the preloader.

Returns:void


showToast

showToast(data?: string, duration?: number): void

Inherited from AuBaseWidget.showToast

Shows a toast.

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

Parameters:

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

Returns:void