Interface ICanvasDefinitionSetPrintArea

Provides properties to set up a print area. For details, you can refer to the SetPrintArea command.

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

Package: ui-framework

Properties

after

The next commands to be executed after this command completes.

Declaration

after?: string | string[]

Property Value

Type	Description
string | string[]	The next commands to be executed after this command completes.

data

The print area definition.

Declaration

data: CustomersCanvas

Property Value

Type	Description
CustomersCanvas	The print area definition.

options

Additional configuration parameters. For details, see the reference.

Declaration

options: any

Property Value

Type	Description
any	Additional configuration parameters. For details, see the reference.

surfaceIndex

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

Declaration

surfaceIndex?: number

Property Value

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