| | Rendition page range. Options: - currentPage
Generate rendition for the current page- entireDocument
Generate rendition for all pages- specificPages
Generate rendition for specific pages
|
| | The intent to set for creating the rendition. Options: - preview
Intent to preview the content.- export
Intent to export/download the content (default).- print
Intent to export and print the content **Note:** For `pdf` format, a print optimized pdf is generated. This option is not supported for `mp4` format.
|
| | Required output format of the rendition. - jpg
"image/jpeg" for JPG format- png
"image/png" for PNG format- mp4
"video/mp4" for MP4 format- pdf
"application/pdf" for PDF format
|
| | The type of rendition. Currently returns "page". |
| | Runtime type of the entrypoint creating this backend object. - panel
add-on's iframe runtime, ie: code running in index.html- script
add-on's document sandbox code ie: code running in code.js- dialog
currently open dialog code
|
| | Types of dialog variants supported. - confirmation
Ask a user to confirm an action.- information
Share information for user to acknowledge.- warning
Share information that a user needs to consider before proceeding.- destructive
Tell a user that if they proceed with an action, it may impact their data in a negative way.- error
Communicate critical issue that a user needs to resolve before proceeding.- input
Ask a user to provide some inputs.- custom
A dialog that can render complex forms and content.
|
| | Video resolution options for the mp4 renditions. - sd480p
"480p"- hd720p
"720p"- fhd1080p
"1080p"- custom
Custom resolution
|
| | The type of modal dialog result. - alert
Alert dialog result (simple dialogs all return this).- input
Input dialog result.- custom
Custom dialog result.
|
| | The type of the button pressed in a dialog. - primary
Primary button pressed.- secondary
Secondary button pressed.- cancel
Cancel button pressed.- close
Dialog closed via ESC or close(X) button.
|
| | Units for the page bleed. - "in" (`Inch`)
Inch units.- "mm" (`Millimeter`)
Millimeter units.
|
