Skip to main content

Interface: IUpdateSurfaceOptionsByDefinition

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

Remarks​

You can use this structure in updateSurfaces.

Example​

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);

Extends​

Properties​

updateRevertData?​

optional updateRevertData?: boolean

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

Inherited from​

IUpdateSurfaceOptions.updateRevertData

preserveUserChanges?​

optional preserveUserChanges?: boolean

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

Inherited from​

IUpdateSurfaceOptions.preserveUserChanges

preserveSafetyLines?​

optional preserveSafetyLines?: boolean

If true, the 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.

Inherited from​

IUpdateSurfaceOptions.preserveSafetyLines

replaceAll?​

optional replaceAll?: boolean

If true, design elements whose names do not match move to the new print area in a random order according to their types. If false, only design elements with the same names are moved to the new print area. The default value is false.

Inherited from​

IUpdateSurfaceOptions.replaceAll

updateSurfaceSize?​

optional updateSurfaceSize?: boolean

If true, changes the surface size to match the new print area or surface. If it's false and a mockup is defined, then the surface size remains unchanged. By default, updateSurfaceSize is false, and the surface size changes only if no mockups are specified.

Inherited from​

IUpdateSurfaceOptions.updateSurfaceSize

surfaces?​

optional surfaces?: number[]

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

Inherited from​

IUpdateSurfaceOptions.surfaces

newProductSurfaces?​

optional newProductSurfaces?: number[]

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

Inherited from​

IUpdateSurfaceOptions.newProductSurfaces

updateBehavior?​

optional updateBehavior?: 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.

Inherited from​

IUpdateSurfaceOptions.updateBehavior

definition​

definition: string | IProductDefinition

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

Was this page helpful?