Specifies options for exporting design blocks to various formats.
The ExportOptions interface provides a set of properties that control the
behavior and quality of the exported content. These options include settings
for JPEG, WebP, PNG, and PDF exports, as well as options for resizing and
adding underlayers.
Extends#
Pick<EngineExportOptions, |"pngCompressionLevel"|"jpegQuality"|"webpQuality"|"exportPdfWithHighCompatibility"|"exportPdfWithUnderlayer"|"underlayerSpotColorName"|"underlayerOffset">
Properties#
| Property | Type | Default value | Description | Inherited from |
|---|---|---|---|---|
mimeType | MimeType | undefined | The mime type of the exported blob | - |
pages? | number[] | undefined | The pages to export with the selected page as the default | - |
pngCompressionLevel? | number | 5. | The PNG compression level to use, when exporting to PNG. Valid values are 0 to 9, higher means smaller, but slower. Quality is not affected. Ignored for other encodings. | Pick.pngCompressionLevel |
jpegQuality? | number | 0.9 | The JPEG quality to use when encoding to JPEG. Valid values are (0-1], higher means better quality. Ignored for other encodings. | Pick.jpegQuality |
webpQuality? | number | undefined | The WebP quality to use when encoding to WebP. Valid values are (0-1], higher means better quality. WebP uses a special lossless encoding that usually produces smaller file sizes than PNG. Ignored for other encodings. Defaults to 1.0. | Pick.webpQuality |
exportPdfWithHighCompatibility? | boolean | undefined | Export the PDF document with a higher compatibility to different PDF viewers. Bitmap images and some effects like gradients will be rasterized with the DPI setting instead of embedding them directly. | Pick.exportPdfWithHighCompatibility |
exportPdfWithUnderlayer? | boolean | undefined | Export the PDF document with an underlayer. An underlayer is generated by adding a graphics block behind the existing elements of the shape of the elements on the page. | Pick.exportPdfWithUnderlayer |
underlayerSpotColorName? | string | undefined | The name of the spot color to be used for the underlayer’s fill. | Pick.underlayerSpotColorName |
underlayerOffset? | number | undefined | The adjustment in size of the shape of the underlayer. | Pick.underlayerOffset |