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

Package: ui-framework

Methods

execute(kvObject<string, CustomersCanvas.IframeApi.ObjectModel.IChannelContainerDefinition>[])

Executes this command.

Declaration

function execute(params: kvObject<string, CustomersCanvas.IframeApi.ObjectModel.IChannelContainerDefinition>[])

Parameters

Type	Name	Description
kvObject<string, CustomersCanvas.IframeApi.ObjectModel.IChannelContainerDefinition>[]	params	Parameters for the command.

Returns

Type	Description
Promise<void>