@aurigma/ui-framework
Version:
A platform which allows building print product personalization editors based on Aurigma's Customer's Canvas.
68 lines (43 loc) • 1.44 kB
Markdown
# Interface: ICanvasDefinitionChangeMockup
Provides properties to change mockups.
For details, you can refer to the [ChangeMockup command](https://customerscanvas.com/dev/editors/ui-framework/widgets/design-editor-commands/change-mockup.html).
```
{
"type": "canvas",
"name": "editor",
"params": {
"initial": { ... },
"changeMockup": [{
"data": {
"mockup": {
"down": "{{$['color']._.props.mockup}}"
},
"previewMockups": "{{$['color']._.props.previews}}"
}
}]
}
}
```
## Hierarchy
* [ICanvasCommandDefinition](icanvascommanddefinition.md)
↳ **ICanvasDefinitionChangeMockup**
## Index
### Properties
* [after](icanvasdefinitionchangemockup.md#optional-after)
* [data](icanvasdefinitionchangemockup.md#data)
* [options](icanvasdefinitionchangemockup.md#options)
## Properties
### `Optional` after
• **after**? : *string | string[]*
*Inherited from [ICanvasCommandDefinition](icanvascommanddefinition.md).[after](icanvascommanddefinition.md#optional-after)*
The next commands to be executed after this command completes.
___
### data
• **data**: *CustomersCanvas.IframeApi.ObjectModel.IMockupData[]*
[Mockup settings](https://customerscanvas.com/dev/editors/iframe-api/reference/design-editor-iframe/imockupdata.html).
___
### options
• **options**: *object*
#### Type declaration:
* **addToHistory**: *boolean*
* **updateRevertData**: *boolean*