---
title: "au-widget-design-editor/Commands/set-background-command | Customer's Canvas On-Premises"
canonical: "https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-design-editor.Commands.set-background-command/"
---

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

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

## Classes

### SetBackgroundCommand

For details, you can refer to the `IDesignEditorDefinitionSetBackground`.
```json
{
  "type": "design-editor", 
  "name": "editor",
  "params": {
    "initial": { ... }, 
    "setBackground": {
      "url": "public:bg_123.pdf"
    }
  }
}
```

#### Extends

- [`DesignEditorWidgetCommand`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-design-editor.Commands.command.md#abstract-designeditorwidgetcommand)

#### Methods

##### execute()

```ts
execute(data): Promise<void>;
```

Executes this command.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `data` | \| [`ISetBackgroundParam`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-design-editor.IAuWidgetDesignEditor.md#isetbackgroundparam) \| [`ISetBackgroundParam`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-design-editor.IAuWidgetDesignEditor.md#isetbackgroundparam)[] |

###### Returns

`Promise`\<`void`\>

###### Overrides

[`DesignEditorWidgetCommand`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-design-editor.Commands.command.md#abstract-designeditorwidgetcommand).[`execute`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-design-editor.Commands.command.md#execute)