Differences
This shows you the differences between two versions of the page.
dglux5_wiki:dataflow:dataflow_blocks_reference:browser_api:export_pdf [2019/10/04 17:35] |
dglux5_wiki:dataflow:dataflow_blocks_reference:browser_api:export_pdf [2021/09/20 15:02] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | {{indexmenu_n>10}} | ||
+ | ====== Export Paginated PDF ====== | ||
+ | |Block Group:|[[dglux5_wiki:dataflow:dataflow_blocks_reference:browser_api:home | Browser API]]| | ||
+ | |Icon:|None| | ||
+ | Exports the contents of the containing view deck or group as a paginated PDF file. | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ===== Input/Output Properties ===== | ||
+ | These properties can take input and give output. | ||
+ | * invoke //(trigger)// | ||
+ | * enabled //(boolean)// | ||
+ | * filename //(string)// | ||
+ | * padding //(string)// | ||
+ | * orientation //(string)// | ||
+ | * units //(string)// | ||
+ | * size //(string)// | ||
+ | * scale //(string)// | ||
+ | |||
+ | **invoke** exports the file, if **enabled** is set to TRUE. | ||
+ | |||
+ | **enabled** specifies whether exporting to PDF is enabled. | ||
+ | |||
+ | **filename** specifies a name for the exported file. If blank, the file is returned as data in **output** and is not downloaded. | ||
+ | |||
+ | **padding** specifies the size of the page margin. | ||
+ | |||
+ | **orientation** specifies the desired page layout. | ||
+ | |||
+ | **units** specifies the units for padding (inches or millimeters). | ||
+ | |||
+ | **size** specifies the page size. | ||
+ | |||
+ | **scale** specifies the resolution factor. To sharpen the rendering of content that might be fuzzy if untreated, increase this setting. | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ===== Output Properties ===== | ||
+ | These properties can give output. They cannot take input. | ||
+ | * output //(string)// | ||
+ | |||
+ | **output** returns the contents of the exported file, if no filename is specified. | ||
+ | |||
+ | ---- | ||
+ | <WRAP left>[[export_html |Previous: Export HTML]]</WRAP> | ||
+ | <WRAP right>[[get_view_property|Next: Get View Property]]</WRAP> |