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

Class: SetBackgroundCommand

A command that replaces the background image in the editor. A command that replaces the background image in the editor.

For details, you can refer to the ICanvasDefinitionSetBackground.

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

For details, you can refer to the IDesignEditorDefinitionSetBackground.

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

Hierarchy

Index

Methods

Methods

execute

execute(params: ICanvasDefinitionSetBackground): Promise‹unknown›

Overrides CanvasWidgetCommand.execute

Executes this command.

Parameters:

Name Type Description
params ICanvasDefinitionSetBackground Parameters for the command.

Returns:Promise‹unknown›