Interface IUpdateSurfaceOptionsByDefinition

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

Inheritance

ISetPrintAreasOptions

IUpdateSurfaceOptions

IUpdateSurfaceOptionsByDefinition

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

definition

A product definition. If this property is a string, then it corresponds to a state file name.

Declaration

definition: IProductDefinition | string;

Property Value

Type	Description
IProductDefinition | string	A product definition. If this property is a string, then it corresponds to a state file name.