Interface IUpdateSurfaceOptions

A structure holding settings to migrate data when replacing surfaces in a product.

Inheritance

ISetPrintAreasOptions

IUpdateSurfaceOptions

Package: @aurigma/design-editor-iframe

Remarks

You can use this structure in updateSurfaces.

Examples

let product = await editor.getProduct();
const options = {
    replaceAll: true,
    definition: "7a6ecf23-1286-4e90-8f18-c7c1c77e3cb0",
    surfaces: [0, 1],
    newProductSurfaces: [1, 4]
};

product = await product.updateSurfaces(options);

Properties

newProductSurfaces

An array of surfaces in the new product to be inserted.

Declaration

newProductSurfaces?: number[];

Property Value

Type	Description
number[]	An array of surfaces in the new product to be inserted.

surfaces

An array of surfaces in the current product to be removed.

Declaration

surfaces?: number[];

Property Value

Type	Description
number[]	An array of surfaces in the current product to be removed.

updateBehavior

Defines how new surfaces will replace existing surfaces in the product. If changeSurfaceLength, removes all pages in the product and replaces them with pages of the new product.

Declaration

updateBehavior?: UpdateSurfaceBehavior;

Property Value

Type	Description
UpdateSurfaceBehavior	Defines how new surfaces will replace existing surfaces in the product. If changeSurfaceLength, removes all pages in the product and replaces them with pages of the new product.