UI Framework ReferenceICanvasDefinitionSetBackground

Interface: ICanvasDefinitionSetBackground

Provides properties to set a design background.

For details, you can refer to the SetBackground command.

{
  "type": "canvas",
  "name": "editor",
  "params": {
    "initial": { ... },
    "setBackground": {
      "url": "public:bg_123.pdf"
    }
  }
}

Hierarchy

Index

Properties

Properties

Optional after

after? : string | string[]

Inherited from ICanvasCommandDefinition.after

Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:30

The next commands to be executed after this command completes.


Optional autoResize

autoResize? : boolean

Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:253

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


Optional surfaceIndex

surfaceIndex? : number

Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:251

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


Optional toTile

toTile? : boolean

Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:256

If true, the background image tiles the entire product.


url

url: string

Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:249

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