Class: SetPrintAreaCommand

A command that sets up a print area. A command that sets up a print area.

For details, you can refer to the 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 the IDesignEditorDefinitionSetPrintArea.

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

Hierarchy

CanvasWidgetCommand
DesignEditorWidgetCommand

↳ SetPrintAreaCommand

Index

Methods

execute

Methods

execute

▸ execute(params: ICanvasDefinitionSetPrintArea[] | ICanvasDefinitionSetPrintArea): Promise‹void›

Overrides CanvasWidgetCommand.execute

Executes this command.

Parameters:

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

Returns:Promise‹void›