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
-
↳ UpdateContainerSettingsCommand
Index
Methods
Methods
execute
▸ execute(params
: kvObject‹string, CustomersCanvas.IframeApi.ObjectModel.IChannelContainerDefinition›[]): Promise‹void›
Overrides CanvasWidgetCommand.execute
Executes this command.
Parameters:
Name | Type | Description |
---|---|---|
params |
kvObject‹string, CustomersCanvas.IframeApi.ObjectModel.IChannelContainerDefinition›[] | Parameters for the command. |
Returns:Promise‹void›