Search
Loading...
Skip to content

Type Alias: ExportOptions

type ExportOptions = object;

Properties#

PropertyTypeDefault valueDescription
mimeType?ImageMimeTypeExclude<ApplicationMimeType, "application/zip">
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.
jpegQuality?number0.9The JPEG quality to use when encoding to JPEG. Valid values are (0-1], higher means better quality. Ignored for other encodings.
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.
targetWidth?numberundefinedAn optional target width used in conjunction with target height. If used, the block will be rendered large enough, that it fills the target size entirely while maintaining its aspect ratio.
targetHeight?numberundefinedAn optional target height used in conjunction with target width. If used, the block will be rendered large enough, that it fills the target size entirely while maintaining its aspect ratio.
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.
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.
underlayerSpotColorName?stringundefinedThe name of the spot color to be used for the underlayer’s fill.
underlayerOffset?numberundefinedThe adjustment in size of the shape of the underlayer.
abortSignal?AbortSignalundefinedAn abortsignal that can be used to cancel the export.