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

Interface: ISetBackgroundParam

Hierarchy

Index

Properties

Properties

Optional after

after? : string | string[]

Inherited from IDesignEditorCommandDefinition.after

The next commands to be executed after this command completes.


Optional autoResize

autoResize? : boolean

If true, resizes the background image to fill the entire product.


Optional showPreloader

showPreloader? : boolean

Inherited from IDesignEditorCommandDefinition.showPreloader

If true, displays the preloader while executing this command.


Optional surfaceIndex

surfaceIndex? : number

The index of a surface that should be modified (the current surface if omitted).


Optional toTile

toTile? : boolean

If true, the background image tiles the entire product.


url

url: string

A URL to the image or a path in Customer's Canvas public gallery.