au-widget-design-editor/Commands/set-background-command

Classes

SetBackgroundCommand

A command that replaces the background image in the editor.

For details, you can refer to the IDesignEditorDefinitionSetBackground.

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

Extends

• DesignEditorWidgetCommand

Methods

execute()

execute(data): Promise<void>;

Executes this command.

Parameters

Parameter	Type
data	| ISetBackgroundParam | ISetBackgroundParam[]

Returns

Promise<void>

Overrides

DesignEditorWidgetCommand.execute