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

Class: AuWidgetGallery

A widget that is used to display a list of images and allows you to select an image.

For details, you can refer to the Gallery widget topic.

{
  "widgets": [
   {
     "type": "gallery",
     "name": "backgrounds",
     "title": "Background",
     "params": {
       "prompt": "Choose a background image",
       "showTitle": true,
       "items": [{
         "title": "Football",
         "name": "something",
         "previewUrl": "/assets/img/something.jpg"
       }]
     }
   }
  ]
}

Hierarchy

AuBaseSelectorWidget

AuWidgetGallery

Implements

Index

Properties

Accessors

Methods

Properties

params

params: IGalleryConfig

Overrides AuBaseWidget.params

Properties of this widget.


paramsRaw

paramsRaw: any

Inherited from AuBaseWidget.paramsRaw

Uncompiled widget configuration.


value

value: IGalleryItem

A gallery item.

Accessors

_

get _(): IGalleryItem

Overrides AuBaseSelectorWidget._

Returns the selected gallery item.

Returns:IGalleryItem

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


clearSelection

clearSelection(): void

Overrides AuBaseSelectorWidget.clearSelection

Resets the selected value.

Returns:void


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


exportWidgetData

exportWidgetData(force: boolean): Promise‹GalleryWidgetData›

Implementation of IRestorableWidget

Parameters:

Name Type
force boolean

Returns:Promise‹GalleryWidgetData›


restoreWidgetFromData

restoreWidgetFromData(widgetData: GalleryWidgetData, force: boolean): Promise‹void›

Parameters:

Name Type
widgetData GalleryWidgetData
force boolean

Returns:Promise‹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