@aurigma/ui-framework
Version:
A platform which allows building print product personalization editors based on Aurigma's Customer's Canvas.
88 lines (53 loc) • 2.29 kB
Markdown
Provides properties to initialize a product in the editor.
For details, you can refer to the [Initial command](https://customerscanvas.com/dev/editors/ui-framework/widgets/design-editor-commands/initial.html).
```
{
"type": "canvas",
"name": "editor",
"params": {
"initial": { ... },
"setViewerSettings": {
"zoom": 0.1,
"zoomMode": 'bestFit',
"scrollPosition": {x: 0, y: 0}
}
}
}
```
* [ICanvasCommandDefinition](icanvascommanddefinition.md)
↳ **ICanvasDefinitionInitial**
* [after](icanvasdefinitioninitial.md
* [editorConfig](icanvasdefinitioninitial.md
* [galleryObserverEnable](icanvasdefinitioninitial.md
* [maximizeAssetManager](icanvasdefinitioninitial.md
* [productDefinition](icanvasdefinitioninitial.md
* [viewerSettings](icanvasdefinitioninitial.md
• **after**? : *string | string[]*
*Inherited from [ICanvasCommandDefinition](icanvascommanddefinition.md).[after](icanvascommanddefinition.md
The next commands to be executed after this command completes.
___
• **editorConfig**: *CustomersCanvas.IframeApi.Configuration.IConfiguration*
The configuration of the editor.
___
• **galleryObserverEnable**? : *boolean*
_Obsolete, use [maximizeAssetManager](icanvasdefinitioninitial.md
___
• **maximizeAssetManager**? : *boolean*
If `true`, opens the Asset Manager in the full-window mode.
___
• **productDefinition**: *CustomersCanvas.IframeApi.ObjectModel.IProductDefinition*
PSD/IDML templates to open. For details, see the [topic about defining products](https://customerscanvas.com/dev/editors/iframe-api/product-definition/multiple-pages.html).
___
• **viewerSettings**? : *[ICanvasDefinitionSetViewerSettings](icanvasdefinitionsetviewersettings.md)*
Canvas zoom properties.