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"
    }
  }
}

Package: ui-framework

Properties

after

The next commands to be executed after this command completes.

Declaration

after?: string | string[]

Property Value

Type	Description
string | string[]	The next commands to be executed after this command completes.

autoResize

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

Declaration

autoResize?: boolean

Property Value

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

surfaceIndex

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

Declaration

surfaceIndex?: number

Property Value

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

toTile

If true, the background image tiles the entire product.

Declaration

toTile?: boolean

Property Value

Type	Description
boolean	If true, the background image tiles the entire product.

url

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

Declaration

url: string

Property Value

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