Interface IProductDefinition

A structure holding settings to create a product.

Inheritance

IModelComponent

IProductDefinition

Package: @aurigma/design-editor-iframe

Examples

const productDefinition = {
  surfaces: {
      // Get surfaces from the folder.
      designFolder: "myphotoBook",
      // Name surfaces as "Page 1", "Page 2", and so on.
      name: "Page {0}",
      // Get mockups from the folder.
      mockupFolder: { up: "photoBookMockups" }
  },
  // Define safety lines for all surfaces (product pages).
  defaultSafetyLines: [{
      margin: 5,
      color: "rgba(0,0,0,1)"
  }]
};

Properties

defaultCropMarks

A collection of default crop marks defined for every surface (page) in the product.

Declaration

defaultCropMarks?: ICropMark[];

Property Value

Type	Description
ICropMark[]	A collection of default crop marks defined for every surface (page) in the product.

defaultDesignLocation

Coordinates of the design relative to the upper-left corner of the mockup, in points.

Declaration

defaultDesignLocation?: IPointF;

Property Value

Type	Description
IPointF	Coordinates of the design relative to the upper-left corner of the mockup, in points.

defaultSafetyLines

A collection of safety lines defined for every surface (page) in the product.

Declaration

defaultSafetyLines?: ISafetyLine[];

Property Value

Type	Description
ISafetyLine[]	A collection of safety lines defined for every surface (page) in the product.

surfaces

A collection of surfaces (pages) defined in the product.

Declaration

surfaces: SurfaceTypes[] | ISurfacesFromFolder | ISurfacesFromMultipageTemplate;

Property Value

Type	Description
SurfaceTypes[] | ISurfacesFromFolder | ISurfacesFromMultipageTemplate	A collection of surfaces (pages) defined in the product.