setPrintArea

• Less than a minute to read

This is an equivalent of the setPrintAreas method from the IFrame API, but only for one surface (either a specified surface or the current surface).

Params

• data - the same print area definition as used in the setPrintAreas.
• surfaceIndex - which surface to replace. If omitted, the currently visible surface is modified.
• options - additional configuration settings. See the ISetPrintAreasOptions for more details.

For the complete list of parameters, you can refer to IDesignEditorDefinitionSetPrintArea.

Example

{
    "type": "design-editor",
    "name": "design-editor",
    "params": {
        "initial": { ... },
        "setPrintArea": [{
            "surfaceIndex": 1,
            "data": {
                "designFile": "{{'demos/cards/'+$['designs']._.title}}"
            },
            "options": {
                "preserveUserChanges": true,
                "updateRevertData": true,
                "updateSurfaceSize": true
            }
        }]
    }
}