API / geotoolkit / report / Document / Document
Type Aliases
Type Aliases
Ƭ DefaultPrintSettings: Object
default print settings
| Name | Type | Description |
|---|---|---|
bottom? | number | margin bottom |
continuous? | boolean | continuous flag |
keepaspectratio? | boolean | keepAspectRatio flag |
left? | number | margin left |
orientation? | PaperOrientation | string | paper orientation |
paperformat? | AbstractPaperFormat | paper format |
right? | number | margin right |
scaling? | ScalingOptions | string | scaling type |
top? | number | margin top |
units? | string | margin units |
Ƭ ExportToPdfOptions: Object
export options
| Name | Type | Description |
|---|---|---|
date? | Date | document title |
documentfooter? | FooterComponent | an optional document PDF footer |
documentheader? | HeaderComponent | an optional document PDF header |
embeddedfonts? | EmbeddedFont[] | array of embedded fonts |
embededfonts? | EmbededFont[] | array of embedded fonts Deprecated since 5.0 use ['embeddedfonts'] instead |
footer? | PageElement | an optional PDF page footer |
header? | PageElement | an optional PDF page header |
imagecompression? | { mode?: ImageCompression ; quality?: number ; speed?: SpeedCompression } | options to specify the image compression |
imagecompression.mode? | ImageCompression | image compression method used to exporting pdf. |
imagecompression.quality? | number | quality range from 0 to 1 that will express the jpeg image compression quality, available for jpeg mode only. |
imagecompression.speed? | SpeedCompression | speed referring to the png compression speed, available for png mode only. |
imagescalefactor? | number | options to specify the image scale factor, right now 8 is maximum, Math.floor(600 / 72) |
options? | { exportscale: number ; imagescalefactor: number ; orientation: Orientation } | Pdf options |
options.exportscale | number | - |
options.imagescalefactor | number | - |
options.orientation | Orientation | - |
output? | string | define optional output filename |
pdfstream? | IWritable | optional user-customized Stream object |
printsettings? | { bottom?: number ; continuous?: boolean ; keepaspectratio?: boolean ; left?: number ; orientation?: PaperOrientation | string ; paperformat?: AbstractPaperFormat ; right?: number ; scaling?: ScalingOptions | string ; top?: number } | define optional paper and export parameters |
printsettings.bottom? | number | define optional bottom margin |
printsettings.continuous? | boolean | continuous printing |
printsettings.keepaspectratio? | boolean | keep aspect ratio |
printsettings.left? | number | define optional left margin |
printsettings.orientation? | PaperOrientation | string | define optional paper orientation |
printsettings.paperformat? | AbstractPaperFormat | define optional paper paper format |
printsettings.right? | number | define optional top margin |
printsettings.scaling? | ScalingOptions | string | define optional scaling mode. Specify to fit all tracks in your page width. |
printsettings.top? | number | define optional top margin |
progress? | (currentPage: number, totalPages: number) => void | Callback to show export progress |
save? | boolean | flag to save the pdf directly to file or open dialog |
skipoutput? | boolean | flag to skip using output and return stream in promise |
streamcompression? | boolean | enable or disable pdf output compression |
title? | string | document title |
truescale? | boolean | enable or disable true scale rendering |