- Introduction
- What's New?
- Features
- Upgrading the Design Editor
- Breaking Changes in 6.0
- Getting Started
- Integration with E-commerce
- Integration with Remote Asset Sources
- Printable Files and Proof Images
- Configuring Products
- Creating Product Templates
- User Interface
- Configuration Files
- APIs
- IFrame API
- Getting Started with IFrame API
- Using the Design Atoms Framework in IFrame API
- Changing the Product Size
- BaseEditor Module
- IframeApi Module
- Commands Module
- Configuration Module
- Editor Class
- loadEditor Function
- ObjectModel Module
- ChannelContainerType Enumeration
- Container Class
- CropMarkTextAlignment Enumeration
- IBarcodeVariable Interface
- IBasePrintAreaDefinition Interface
- IBaseSurfaceDefinition Interface
- IBaseSurfacesDefinition Interface
- IBgFoldingModeParams Interface
- IChannelContainerDefinition Interface
- ICropMark Interface
- ICropMarkText Interface
- IFoldingLine Interface
- IHiResOutput Interface
- IMarginHV Interface
- IMarginLTRB Interface
- IMockupData Interface
- IMockupFolders Interface
- IMockupTemplate Interface
- IModelComponent Interface
- IPageTemplate Interface
- IPointF Interface
- IPrintAreaDefinition Interface
- IPrintAreaTemplate Interface
- IProductDefinition Interface
- IProofImage Interface
- IRectangleF Interface
- ISafetyLine Interface
- ISetPrintAreasOptions Interface
- ISize Interface
- ISpine Interface
- IStateSurface Interface
- IStateSurfaces Interface
- ISurfaceDefinition Interface
- ISurfaceFromState Interface
- ISurfacesFromFolder Interface
- ISurfacesFromMultipageTemplate Interface
- ISurfaceTemplate Interface
- ITagsDictionary Interface
- Item Class
- IUpdateSurfaceOptionsByDefinition Interface
- IVariable Interface
- PdfBox Enumeration
- PrintArea Class
- Product Class
- Surface Class
- SurfaceMockup Class
- PostMessage Module
- preload Function
- RuntimeConfiguration Class
- Web API
- Design Atoms Framework
- UI Framework
- Dynamic Image API
- IFrame API
- Add-ons
- System Requirements
- Troubleshooting
- Migrating Your Applications
- Licensing
- Copyright Notices
IUpdateSurfaceOptionsByDefinition Interface
Applies to: Customer's Canvas On-Premises; Design Editor 6.15.0, 6.x (may differ) · Archived documentation
A structure holding settings to migrate data when replacing surfaces in a product.
You can use this structure in updateSurfaces.
Properties
definition
A product definition. If this property is a string, then it corresponds to a state file name.
Optional newProductSurfaces
An array of surfaces in the new product to be inserted.
Optional preserveSafetyLines
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.
Optional preserveUserChanges
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.
Optional replaceAll
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.
Optional surfaces
An array of surfaces in the current product to be removed.
Optional updateRevertData
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.
Optional updateSurfaceSize
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.