setPrintAreas Method

Callable

  • Sets new print areas for the surface. Returns new product instance containing the changed surface.

    example
    newPrintAreas = [{
        designFile: "stamp"
    }];
    
    editor.getProduct()
        .then(function (product) {
            return product.surfaces[0].setPrintAreas(newPrintAreas);
        })
        .then(function (product) {
            console.log("A print area is successfully set for product " + product.id);
        })
        .catch(function (error) {
            console.error("Setting a print area failed with exception: ", error);
        });
    

    Parameters

    • printAreas: ( IPrintAreaTemplate | IPrintAreaDefinition ) []

      Print areas to set.

    • Optional options: object

      Additional configuration settings for the print areas.

      • Optional preserveSafetyLines: boolean

        If true, then current safety lines, if any, are restored in new print areas. If false, safety lines from new print areas are applied. The default value is true.

      • Optional preserveUserChanges: boolean

        If true, then changes made by a user are restored in the new print areas if it is possible. Otherwise, all changes made by the user are wiped. The default value is true.

      • Optional updateRevertData: boolean

        If true, the new print areas are stored as ones to restore when the product is reverted. Otherwise, the previously stored print areas are restored on product revert. The default value is true.

    Returns Promise < Product >

    A new product instance containing the changed surface.