Class InitialCommand

A command that defines a product and configures the editor. A command that defines a product and configures the editor. For details, you can refer to ICanvasDefinitionInitial.

{
  "widgets": [{
    "type": "canvas",
    "name": "editor",
    "params": {
      "initial":{
        "productDefinition":{
          "surfaces":[{ "printAreas": [{ "designFile": "mytemplate" }] }]
        },
        "editorConfig": {
          "initialMode": "Advanced"
        }
      }
    }
  }]
}

For details, you can refer to IDesignEditorDefinitionInitial.

{
  "widgets": [{
    "type": "design-editor",
    "name": "editor",
    "params": {
      "initial":{
        "productDefinition":{
          "surfaces":[{ "printAreas": [{ "designFile": "mytemplate" }] }]
        },
        "editorConfig": {
          "initialMode": "Advanced"
        }
      }
    }
  }]
}

Package: ui-framework

Methods

execute(ICanvasDefinitionInitial)

Executes this command.

Declaration

function execute(params: ICanvasDefinitionInitial)

Parameters

Type	Name	Description
ICanvasDefinitionInitial	params	Parameters for the command.

Returns

Type	Description
Promise<any>