Interface IStateSurfaces

A structure holding a state file name and an array of surface names.

Package: @aurigma/design-editor-iframe

Examples

let product = await editor.getProduct();

// Add the first three pages from the state file to the product.
await product.addSurfaces({
    stateId: "3c040958-bfa8-4a3e-b3af-cff9257e7fa1",
    surfaces: ["0", "surface_1", "surface_2"]
})
// If an error occurred while adding pages to the product.
.catch(error => console.error("Adding surfaces failed with exception: ", error));

Properties

name

A new name of surfaces.

Declaration

name?: string;

Property Value

Type	Description
string	A new name of surfaces.

stateId

The name of a state file.

Declaration

stateId: string;

Property Value

Type	Description
string	The name of a state file.

surfaces

An array of surface names or indexes starting from 0. When you skip this array, all pages of the state file are added to a product.

Declaration

surfaces?: string[];

Property Value

Type	Description
string[]	An array of surface names or indexes starting from 0. When you skip this array, all pages of the state file are added to a product.