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 IDesignEditorDefinitionSetBackground.

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

Package: ui-framework

Methods

execute(ICanvasDefinitionSetBackground)

Executes this command.

Declaration

function execute(params: ICanvasDefinitionSetBackground)

Parameters

Type	Name	Description
ICanvasDefinitionSetBackground	params	Parameters for the command, an object or an array of objects.

Returns

Type	Description
Promise<unknown>