UI Framework Reference › UpdateContainerSettingsCommand

Class: UpdateContainerSettingsCommand

A command that updates channel containers with new parameters. A command that updates channel containers with new parameters.

For details, see the IChannelContainerDefinition topic.

{
  "type": "canvas",
  "name": "editor",
  "params": {
    "initial": { ... },
    "updateContainerSettings": [
      {
        "Foil": {
          "texture": "{{ $['foil']._.props.texture }}"
        },
        "Raised Ink": {
          "texture": "{{ $['paper']._.props.textColor }}"
        }
      }
    ]
  }
}

For details, see the IChannelContainerDefinition topic.

{
  "type": "design-editor",
  "name": "editor",
  "params": {
    "initial": { ... },
    "updateContainerSettings": [
      {
        "Foil": {
          "texture": "{{ $['foil']._.props.texture }}"
        },
        "Raised Ink": {
          "texture": "{{ $['paper']._.props.textColor }}"
        }
      }
    ]
  }
}

Hierarchy

CanvasWidgetCommand
DesignEditorWidgetCommand

↳ UpdateContainerSettingsCommand

Index

Methods

execute

Methods

execute

▸ execute(params: kvObject‹string, CustomersCanvas.IframeApi.ObjectModel.IChannelContainerDefinition›[]): Promise‹void›

Overrides CanvasWidgetCommand.execute

Defined in src/widgets/au-widget-canvas/Commands/update-container-settings-command.ts:32

Executes this command.

Parameters:

Name	Type	Description
`params`	kvObject‹string, CustomersCanvas.IframeApi.ObjectModel.IChannelContainerDefinition›[]	Parameters for the command.

Returns:Promise‹void›