Class SetPrintAreaCommand

A command that sets up a print area. A command that sets up a print area. For details, you can refer to ICanvasDefinitionSetPrintArea.

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

For details, you can refer to IDesignEditorDefinitionSetPrintArea.

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

Package: ui-framework

Methods

execute(ICanvasDefinitionSetPrintArea[] | ICanvasDefinitionSetPrintArea)

Executes this command.

Declaration

function execute(params: ICanvasDefinitionSetPrintArea[] | ICanvasDefinitionSetPrintArea)

Parameters

Type	Name	Description
ICanvasDefinitionSetPrintArea[] | ICanvasDefinitionSetPrintArea	params	Parameters for the command.

Returns

Type	Description
Promise<void>