UI Framework ReferenceICanvasDefinitionInitial

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}
    }
  }
}

Hierarchy

Index

Properties

Properties

Optional after

after? : string | string[]

Inherited from ICanvasCommandDefinition.after

Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:30

The next commands to be executed after this command completes.


editorConfig

editorConfig: CustomersCanvas.IframeApi.Configuration.IConfiguration

Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:165

The configuration of the editor.


Optional galleryObserverEnable

galleryObserverEnable? : boolean

Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:168


Optional maximizeAssetManager

maximizeAssetManager? : boolean

Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:169


productDefinition

productDefinition: CustomersCanvas.IframeApi.ObjectModel.IProductDefinition

Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:163

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


Optional viewerSettings

viewerSettings? : ICanvasDefinitionSetViewerSettings

Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:167

Canvas zoom properties.