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

Interface: IDesignEditorDefinitionSetPrintArea

Provides properties to set up a print area.

For details, you can refer to the SetPrintArea command.

{
  "type": "design-editor",
  "name": "editor",
  "params": {
    "initial": { ... },
    "setPrintArea": {
      "options": {
        "preserveUserChanges": true,
        "updateRevertData": false
      },
      "data": {
        "designFile": "{{vars.designRoot + '/' + $['card-size']._.title}}"
      }
    }
  }
}

Hierarchy

Index

Properties

Properties

Optional after

after? : string | string[]

Inherited from IDesignEditorCommandDefinition.after

The next commands to be executed after this command completes.


data

data: CustomersCanvas.IframeApi.ObjectModel.IPrintAreaTemplate | CustomersCanvas.IframeApi.ObjectModel.IPrintAreaDefinition

The print area definition.


options

options: ISetPrintAreaOptions

Additional configuration parameters. For details, see the reference.


Optional showPreloader

showPreloader? : boolean

Inherited from IDesignEditorCommandDefinition.showPreloader

If true, displays the preloader while executing this command.


Optional surfaceIndex

surfaceIndex? : number

The index of a surface that should be modified (the current surface if omitted).