Set the output page size.
Possible values: "A0", "A1", "A2", "A3", "A4", "A5", "A6", "Letter"
Set the output page width. The safe maximum is 200in otherwise some PDF viewers may be unable to open the PDF.
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Set the output page height. Use -1 for a single page PDF. The safe maximum is 200in otherwise some PDF viewers may be unable to open the PDF.
The value must be -1 or specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Set the output page orientation.
Possible values: "landscape", "portrait"
Set the output page top margin.
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Set the output page right margin.
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Set the output page bottom margin.
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Set the output page left margin.
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Set the page range to print.
A comma separated list of page numbers or ranges.
Set an offset between physical and logical page numbers.
Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area.
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". It may contain a negative value.
Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area.
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". It may contain a negative value.
Set the width of the content area. It should be at least 1 inch.
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Set the height of the content area. It should be at least 1 inch.
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Specifies behavior in presence of CSS @page rules. It may affect the page size, margins and orientation.
It is available for API client version >= 5.0.0 and applicable for converter version >= 20.10.
More Pdfcrowd
versioning details.
Possible values:
- "default" - The Pdfcrowd API page settings are preferred.
- "mode1" - The converter version 18.10 mode.
- "mode2" - CSS @page rule is preferred.
Specifies which blank pages to exclude from the output document.
It is available for API client version >= 5.13.0 and applicable for converter version >= 20.10.
More Pdfcrowd
versioning details.
Possible values:
- "trailing" - Trailing blank pages are removed from the document.
- "none" - No blank page is removed from the document.
Use the print version of the page if available (@media print).
Do not print the background graphics.
Do not execute JavaScript.
Disable loading fonts from remote sources.
Use a mobile user agent.
It is available for API client version >= 5.3.0 and applicable for converter version >= 20.10.
More Pdfcrowd
versioning details.
Specifies how iframes are handled.
It is available for API client version >= 5.0.0 and applicable for converter version >= 20.10.
More Pdfcrowd
versioning details.
Possible values:
- "all" - All iframes are loaded.
- "same-origin" - Only iframes with the same origin as the main page are loaded.
- "none" - Iframe loading is disabled.
Try to block ads. Enabling this option can produce smaller output and speed up the conversion.
Set the default HTML content text encoding.
Set the locale for the conversion. This may affect the output format of dates, times and numbers.
It is available for API client version >= 5.0.0 and applicable for converter version >= 20.10.
More Pdfcrowd
versioning details.
Set the HTTP authentication user name.
Set the HTTP authentication password.
Set cookies that are sent in Pdfcrowd HTTP requests.
Do not allow insecure HTTPS connections.
Abort the conversion if the main URL HTTP status code is greater than or equal to 400.
Abort the conversion if any of the sub-request HTTP status code is greater than or equal to 400 or if some sub-requests are still pending. See details in a debug log.
Do not send the X-Pdfcrowd HTTP header in Pdfcrowd HTTP requests.
Run a custom JavaScript after the document is loaded and ready to print. The script is intended for post-load DOM manipulation (add/remove elements, update CSS, ...). In addition to the standard browser APIs, the custom JavaScript code can use helper functions from our
JavaScript library.
Run a custom JavaScript right after the document is loaded. The script is intended for early DOM manipulation (add/remove elements, update CSS, ...). In addition to the standard browser APIs, the custom JavaScript code can use helper functions from our
JavaScript library.
Set a custom HTTP header that is sent in Pdfcrowd HTTP requests.
A string containing the header name and value separated by a colon.
Wait the specified number of milliseconds to finish all JavaScript after the document is loaded. Your API license defines the maximum wait time by "Max Delay" parameter.
Must be a positive integer number or 0.
Convert only the specified element from the main document and its children. The element is specified by one or more
CSS selectors. If the element is not found, the conversion fails. If multiple elements are found, the first one is used.
Specify the DOM handling when only a part of the document is converted. This can affect the CSS rules used.
Possible values:
- "cut-out" - The element and its children are cut out of the document.
- "remove-siblings" - All element's siblings are removed.
- "hide-siblings" - All element's siblings are hidden.
Wait for the specified element in a source document. The element is specified by one or more
CSS selectors. The element is searched for in the main document and all iframes. If the element is not found, the conversion fails. Your API license defines the maximum wait time by "Max Delay" parameter.
The main HTML element for conversion is detected automatically.
It is available for API client version >= 5.5.0 and applicable for converter version >= 20.10.
More Pdfcrowd
versioning details.
The input HTML is automatically enhanced to improve the readability.
It is available for API client version >= 5.5.0 and applicable for converter version >= 20.10.
More Pdfcrowd
versioning details.
Possible values:
- "none" - No enhancements are used.
- "readability-v1" - Version 1 of the enhancements is used.
- "readability-v2" - Version 2 of the enhancements is used.
- "readability-v3" - Version 3 of the enhancements is used.
- "readability-v4" - Version 4 of the enhancements is used.
Set the viewport width in pixels. The viewport is the user's visible area of the page.
The value must be in the range 96-65000.
Set the viewport height in pixels. The viewport is the user's visible area of the page. If the input HTML uses lazily loaded images, try using a large value that covers the entire height of the HTML, e.g. 100000.
Must be a positive integer number.
Set the rendering mode.
Possible values:
- "default" - The mode based on the standard browser print functionality.
- "viewport" - The viewport width affects the @media min-width and max-width CSS properties. This mode can be used to choose a particular version (mobile, desktop, ..) of a responsive page.
Specifies the scaling mode used for fitting the HTML contents to the print area.
Possible values:
- "default" - The mode based on the standard browser print functionality.
- "disabled" - No smart scaling is performed.
- "viewport-fit" - The viewport width fits the print area width.
- "content-fit" - The HTML contents width fits the print area width.
- "single-page-fit" - The whole HTML contents fits the print area of a single page.
- "single-page-fit-ex" - The whole HTML contents fits the print area of a single page with respect to the page height/width ratio.
- "mode1" - Scaling mode 1 is applied.
Set the scaling factor (zoom) for the main page area.
The value must be in the range 10-500.
Set the quality of embedded JPEG images. A lower quality results in a smaller PDF file but can lead to compression artifacts.
The value must be in the range 1-100.
Specify which image types will be converted to JPEG. Converting lossless compression image formats (PNG, GIF, ...) to JPEG may result in a smaller PDF file.
Possible values:
- "none" - No image conversion is done.
- "opaque" - Only opaque images are converted to JPEG images.
- "all" - All images are converted to JPEG images. The JPEG format does not support transparency so the transparent color is replaced by a PDF page background color.
Set the DPI of images in PDF. A lower DPI may result in a smaller PDF file. If the specified DPI is higher than the actual image DPI, the original image DPI is retained (no upscaling is performed). Use 0 to leave the images unaltered.
Must be a positive integer number or 0.
Specify the page layout to be used when the document is opened.
Possible values:
- "single-page" - Display one page at a time.
- "one-column" - Display the pages in one column.
- "two-column-left" - Display the pages in two columns, with odd-numbered pages on the left.
- "two-column-right" - Display the pages in two columns, with odd-numbered pages on the right.
Specify how the document should be displayed when opened.
Possible values:
- "full-screen" - Full-screen mode.
- "thumbnails" - Thumbnail images are visible.
- "outlines" - Document outline is visible.
Specify how the page should be displayed when opened.
Possible values:
- "fit-width" - The page content is magnified just enough to fit the entire width of the page within the window.
- "fit-height" - The page content is magnified just enough to fit the entire height of the page within the window.
- "fit-page" - The page content is magnified just enough to fit the entire page within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the page within the window in the other dimension.
Display the specified page when the document is opened.
Must be a positive integer number.
Specify the initial page zoom in percents when the document is opened.
Must be a positive integer number.
Specify whether to hide the viewer application's tool bars when the document is active.
Specify whether to hide the viewer application's menu bar when the document is active.
Specify whether to hide user interface elements in the document's window (such as scroll bars and navigation controls), leaving only the document's contents displayed.
Specify whether to resize the document's window to fit the size of the first displayed page.
Specify whether to position the document's window in the center of the screen.
Specify whether the window's title bar should display the document title. If false , the title bar should instead display the name of the PDF file containing the document.
Set the predominant reading order for text to right-to-left. This option has no direct effect on the document's contents or page numbering but can be used to determine the relative positioning of pages when displayed side by side or printed n-up