TrophyCustomer's Canvas is honored with a 2020 InterTech Technology Award! Learn more 

Interface: IDesignEditorDefinitionInitial

Provides properties to initialize a product in the editor.

For details, you can refer to the Initial command.

{
  "type": "design-editor",
  "name": "editor",
  "params": {
    "initial": { ... },
    "setViewerSettings": {
      "zoom": 0.1,
      "zoomMode": 'bestFit',
      "scrollPosition": {x: 0, y: 0}
    }
  }
}

Hierarchy

Index

Properties

Properties

Optional after

after? : string | string[]

Inherited from IDesignEditorCommandDefinition.after

The next commands to be executed after this command completes.


editorConfig

editorConfig: CustomersCanvas.IframeApi.Configuration.IConfiguration

The configuration of the editor.


Optional maximizeAssetManager

maximizeAssetManager? : boolean

Opens the Asset Manager in the full-window mode.


Optional onItemAdded

onItemAdded? : Function | Function[]

A function that is executed after adding an item.


Optional onItemChanged

onItemChanged? : Function | Function[]

A function that is executed after changing an item.


Optional onItemRemoved

onItemRemoved? : Function | Function[]

A function that is executed after removing an item.


Optional onProductRevert

onProductRevert? : Function | Function[]

A function that is executed after clicking the Revert Product button.


productDefinition

productDefinition: CustomersCanvas.IframeApi.ObjectModel.IProductDefinition

PSD/IDML templates to open. For details, see the topic about defining products.


Optional showPreloader

showPreloader? : boolean

Inherited from IDesignEditorCommandDefinition.showPreloader

If true, displays the preloader while executing this command.


Optional viewerSettings

viewerSettings? : IDesignEditorDefinitionSetViewerSettings

Canvas zoom properties.