Type alias OutputType

OutputType: {
    description?: string;
    id: string;
    name: string;
    settings: {
        bleed: number;
        configuredBleed: number;
        coverAddition: {
            configuredCoverWrap: number;
            height: number;
            width: number;
            wrap: number;
        };
        duplexPrinting: boolean;
        gutter: {
            size: number;
            url: string;
        };
        margin: {
            bottom: number;
            left: number;
            right: number;
            top: number;
        };
        priceFactor: number;
    };
}

MegaEdit products have various components:

the Canvas along with a CanvasSize
the StockItem
the OutputType

The output type object controls elements like

bleed
cover options
gutter
print production
margins
how pages are set together (single page vs spread)

Multiple output types can be assigned to a product and the user can switch between them.

Type declaration

Optional description?: string

The optional description of the output type
id: string

The id of the output type (GUID)
name: string

The name of the output type
settings: {
    bleed: number;
    configuredBleed: number;
    coverAddition: {
        configuredCoverWrap: number;
        height: number;
        width: number;
        wrap: number;
    };
    duplexPrinting: boolean;
    gutter: {
        size: number;
        url: string;
    };
    margin: {
        bottom: number;
        left: number;
        right: number;
        top: number;
    };
    priceFactor: number;
}

The settings for the output type
- bleed: number
  
  The bleed currently visible in the editor in points. Usually this is the same as the configured bleed, but if the bleed is hidden, this value will be 0.
- configuredBleed: number
  
  The configured bleed in points. This will be the configured value no matter if the bleed is hidden or not.
- coverAddition: {
      configuredCoverWrap: number;
      height: number;
      width: number;
      wrap: number;
  }
  
  Cover addition values. This allows to have different dimensions and wrap (aka bleed) for the cover pages
  - configuredCoverWrap: number
    
    The configured wrap in points. This will be the configured value no matter if the bleed is hidden or not.
  - height: number
    
    The additional width to add to the cover pages in points
  - width: number
    
    The additional width to add to the cover pages in points.
  - wrap: number
    
    The wrap (value in points) is used instead of the bleed for cover pages - as it can be wrapped around the cover for production it allows a different value. This may be 0 if the bleed (and wrap) is hidden.
- duplexPrinting: boolean
  
  Flag if duplex printing is used. This is used to calculate the spine thickness
- gutter: {
  size: number;
  url: string;
  }
  
  The gutter configuration. The gutter is used for separate pages in a spread configuration.
  - size: number
    
    The gutter size (additional width) in points when creating the individual spread halves.
  - url: string
    
    A URL for an optional image to display within the gutter
- margin: {
      bottom: number;
      left: number;
      right: number;
      top: number;
  }
  
  The margin configuration for the pages. Margins are optional and virtual boundaries and can be used to snap to.
  - bottom: number
    
    The bottom margin in points.
  - left: number
    
    The left margin in points.
  - right: number
    
    The right margin in points.
  - top: number
    
    The top margin in points.
- priceFactor: number
  
  The price factor for the output type

Example

{
    "id": "fb75ffbb-201e-4f29-9408-c5c3a7744748",
    "description": null,
    "name": "Mug",
    "settings": {
        "coverAddition": {
            "width": 0,
            "height": 0,
            "wrap": 0,
            "configuredCoverWrap": 0
        },
        "bleed": 0,
        "configuredBleed": 0,
        "duplexPrinting": false,
        "gutter": {
            "size": 0,
            "url": ""
        },
        "margin": {
            "top": 0,
            "left": 0,
            "right": 0,
            "bottom": 0
        },
        "priceFactor": 1
    },
    "previewThumbnail": ""
}

Type alias OutputType

Type declaration

`Optional` description?: string

id: string

name: string

bleed: number

configuredBleed: number

coverAddition: {
    configuredCoverWrap: number;
    height: number;
    width: number;
    wrap: number;
}

configuredCoverWrap: number

height: number

width: number

wrap: number

duplexPrinting: boolean

gutter: {
size: number;
url: string;
}

size: number

url: string

margin: {
    bottom: number;
    left: number;
    right: number;
    top: number;
}

bottom: number

left: number

right: number

top: number

priceFactor: number

Example

Settings

Member Visibility

Theme

Type alias OutputType

Type declaration

Optional description?: string

id: string

name: string

bleed: number

configuredBleed: number

coverAddition: { configuredCoverWrap: number; height: number; width: number; wrap: number; }

configuredCoverWrap: number

height: number

width: number

wrap: number

duplexPrinting: boolean

gutter: { size: number; url: string; }

size: number

url: string

margin: { bottom: number; left: number; right: number; top: number; }

bottom: number

left: number

right: number

top: number

priceFactor: number

Example

Settings

Member Visibility

Theme

`Optional` description?: string

coverAddition: {
configuredCoverWrap: number;
height: number;
width: number;
wrap: number;
}

gutter: {
size: number;
url: string;
}

margin: {
bottom: number;
left: number;
right: number;
top: number;
}