Interface ICanvasDefinitionInitial

Provides properties to initialize a product in the editor. For details, you can refer to the Initial command.

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

Package: ui-framework

Properties

after

The next commands to be executed after this command completes.

Declaration

after?: string | string[]

Property Value

Type	Description
string | string[]	The next commands to be executed after this command completes.

editorConfig

The configuration of the editor.

Declaration

editorConfig: CustomersCanvas.IframeApi.Configuration.IConfiguration

Property Value

Type	Description
CustomersCanvas.IframeApi.Configuration.IConfiguration	The configuration of the editor.

galleryObserverEnable

Obsolete, use maximizeAssetManager instead. If true, hides all panels and only displays the Asset Manager.

Declaration

galleryObserverEnable?: boolean

Property Value

Type	Description
boolean	Obsolete, use maximizeAssetManager instead. If true, hides all panels and only displays the Asset Manager.

maximizeAssetManager

If true, opens the Asset Manager in the full-window mode.

Declaration

maximizeAssetManager?: boolean

Property Value

Type	Description
boolean	If true, opens the Asset Manager in the full-window mode.

productDefinition

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

Declaration

productDefinition: CustomersCanvas.IframeApi.ObjectModel.IProductDefinition

Property Value

Type	Description
CustomersCanvas.IframeApi.ObjectModel.IProductDefinition	PSD/IDML templates to open. For details, see the topic about defining products.

viewerSettings

Canvas zoom properties.

Declaration

viewerSettings?: ICanvasDefinitionSetViewerSettings

Property Value

Type	Description
ICanvasDefinitionSetViewerSettings	Canvas zoom properties.