UI Framework ReferenceIDesignEditorDefinitionInitial

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

Defined in src/widgets/au-widget-design-editor/IAuWidgetDesignEditor.ts:32

The next commands to be executed after this command completes.


editorConfig

editorConfig: CustomersCanvas.IframeApi.Configuration.IConfiguration

Defined in src/widgets/au-widget-design-editor/IAuWidgetDesignEditor.ts:168

The configuration of the editor.


Optional maximizeAssetManager

maximizeAssetManager? : boolean

Defined in src/widgets/au-widget-design-editor/IAuWidgetDesignEditor.ts:174

Opens the Asset Manager in the full window mode.


productDefinition

productDefinition: CustomersCanvas.IframeApi.ObjectModel.IProductDefinition

Defined in src/widgets/au-widget-design-editor/IAuWidgetDesignEditor.ts:166

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


Optional viewerSettings

viewerSettings? : IDesignEditorDefinitionSetViewerSettings

Defined in src/widgets/au-widget-design-editor/IAuWidgetDesignEditor.ts:170

Canvas zoom properties.