Search
Loading...
Skip to content

Interface: ExportOptions

Extends#

  • Pick<EngineExportOptions, | "pngCompressionLevel" | "jpegQuality" | "webpQuality" | "exportPdfWithHighCompatibility" | "exportPdfWithUnderlayer" | "underlayerSpotColorName" | "underlayerOffset">

Properties#

PropertyTypeDefault valueDescriptionInherited from
mimeTypeMimeTypeundefinedThe mime type of the exported blob-
pages?number[]undefinedThe pages to export with the selected page as the default-
pngCompressionLevel?number5.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?number0.9The JPEG quality to use when encoding to JPEG. Valid values are (0-1], higher means better quality. Ignored for other encodings.Pick.jpegQuality
webpQuality?numberundefinedThe 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?booleanundefinedExport 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?booleanundefinedExport 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?stringundefinedThe name of the spot color to be used for the underlayer’s fill.Pick.underlayerSpotColorName
underlayerOffset?numberundefinedThe adjustment in size of the shape of the underlayer.Pick.underlayerOffset