dglux5_wiki:dataflow:dataflow_blocks_reference:browser_api:export_pdf

Action unknown: plugin_bookcreator__addtobook

Export Paginated PDF

Block Group: Browser API
Icon:None

Exports the contents of the containing view deck or group as a paginated PDF file. Each child of the group or view deck becomes a separate page.


These properties can take input and give output.

  • invoke (trigger)
  • enabled (boolean)
  • filename (string)
  • location (enum)
  • padding (number)
  • orientation (enum)
  • units (enum)
  • size (enum)
  • scale (number)

invoke exports the file, if enabled is set to TRUE.

enabled specifies whether exporting to PDF is enabled. The default is TRUE.

filename specifies a name for the exported file. If the name has no extension, .pdf is appended. If blank, the file is returned as binary data in output and is not saved. When you add this block from the palette, filename is download.

location specifies where the file is saved, if filename is set.

  • download: The file is downloaded by the browser. This is the default.
  • project: The file is saved in the DGLux5 project, using filename as the path. If a file with that name already exists, the file is not saved, error returns "File already exists", and onError fires.

padding specifies the margin around the content of each page, in pixels. The default is 20.

orientation specifies the page layout: landscape (default) or portrait.

units specifies the measurement unit used for the PDF document: pt, mm (default), cm, or in.

size specifies the page size: a3, a4, a5 (default), letter, legal, or autosize. With autosize, the page is sized to fit the content of the first page.

scale specifies the resolution factor. To sharpen the rendering of content that might be fuzzy if untreated, increase this setting. The default is 1.


These properties can give output. They cannot take input.

  • loading (boolean)
  • output (binary)
  • onComplete (event)
  • onError (event)
  • error (string)

loading returns TRUE while the file is being exported.

output returns the contents of the exported file as binary data, if no filename is specified.

onComplete fires when the file has been saved in the project (location is project).

onError fires when saving the file in the project fails.

error returns the error message, if saving the file in the project fails.

loading, onComplete, onError, and error are hidden on the block by default.


  • dglux5_wiki/dataflow/dataflow_blocks_reference/browser_api/export_pdf.txt
  • Last modified: 2026/10/22 13:25
  • by 127.0.0.1