HTML to PDF Command Line Reference
Conversion from HTML to PDF.
usage: html2pdf [options] source
Source to be converted. It can be URL, path to a local
file or '-' to use stdin as an input text.
Options
Page Setup
Set the output page size.
Allowed values:
-
A0
-
A1
-
A2
-
A3
-
A4
-
A5
-
A6
-
Letter
Default: A4
Set the output page width. The safe maximum is 200in otherwise some PDF viewers may be unable to open the PDF.
Constraint:
- The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Default: 8.27in
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.
Constraint:
- The value must be -1 or specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Default: 11.7in
Set the output page orientation.
Set the output page top margin.
Constraint:
- The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Default: 0.4in
Set the output page right margin.
Constraint:
- The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Default: 0.4in
Set the output page bottom margin.
Constraint:
- The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Default: 0.4in
Set the output page left margin.
Constraint:
- The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Default: 0.4in
Disable page margins.
Allowed values:
-
true, 1 or on
-
false, 0 or off
Default: False
Set the page range to print.
Constraint:
- A comma separated list of page numbers or ranges. Special strings may be used, such as `odd`, `even` and `last`.
Examples:
-
Just the second page is printed.
"2"
-
The first, third, and last pages are printed.
"1,3,last"
-
Everything except the first page is printed.
"2-"
-
Just first 3 pages are printed.
"-3"
-
Pages 3, 6, 7, 8 and 9 are printed.
"3,6-9"
Set the viewport width for formatting the HTML content when generating a PDF. By specifying a viewport width, you can control how the content is rendered, ensuring it mimics the appearance on various devices or matches specific design requirements.
Availability:
API client >= 6.0.0, converter >= 24.04.
See
versioning.
Constraint:
- The value must be "balanced", "small", "medium", "large", "extra-large", or a number in the range 96-65000.
Allowed values:
-
balanced
The smart option to adjust the viewport width dynamically to fit the print area, ensuring an optimal layout.
-
small
A compact layout where less text fits on each PDF page, ideal for detailed sections or mobile views.
-
medium
A balanced amount of text per page, striking a good compromise between readability and content density.
-
large
A broader layout that accommodates more text per page, perfect for reducing page count and enhancing flow.
-
extra-large
Maximize the text per page, creating a spacious and content-rich PDF, akin to a widescreen experience.
-
A precise viewport width in pixels, such as 1000, to tailor the PDF's text density to your specific requirements. The value must be in the range 96-65000.
Default: medium
Set the viewport height for formatting the HTML content when generating a PDF. By specifying a viewport height, you can enforce loading of lazy-loaded images and also affect vertical positioning of absolutely positioned elements within the content.
Availability:
API client >= 6.0.0, converter >= 24.04.
See
versioning.
Constraint:
- The value must be "auto", "large", or a number.
Allowed values:
-
auto
The height of the print area is used.
-
large
Value suitable for documents with extensive lazy-loaded content.
-
A specific numerical value to set as the window height, allowing precise control based on the document's requirements.
Default: auto
Specifies the mode for fitting the HTML content to the print area by upscaling or downscaling it.
Availability:
API client >= 6.0.0, converter >= 24.04.
See
versioning.
Allowed values:
-
auto
Automatic mode
-
smart-scaling
Smartscaling to fit more content into the print area.
-
no-scaling
No scaling is performed.
-
viewport-width
The viewport width fits the print area width.
-
content-width
The HTML content width fits the print area width.
-
single-page
The entire HTML content fits the print area of a single page.
-
single-page-ratio
The entire HTML content fits the print area of a single page, maintaining the aspect ratio of the page height and width.
Default: auto
Specifies which blank pages to exclude from the output document.
Availability:
API client >= 5.13.0, converter >= 20.10.
See
versioning.
Allowed values:
-
trailing
Trailing blank pages are removed from the document.
-
all
All empty pages are removed from the document.
Availability:
API client >= 6.0.0, converter >= 24.04.
-
none
No blank page is removed from the document.
Default: trailing
Load an HTML code from the specified URL and use it as the page header. The following classes can be used in the HTML. The content of the respective elements will be expanded as follows:
- pdfcrowd-page-count - the total page count of printed pages
- pdfcrowd-page-number - the current page number
- pdfcrowd-source-url - the source URL of the converted document
- pdfcrowd-source-title - the title of the converted document
The following attributes can be used:
- data-pdfcrowd-number-format - specifies the type of the used numerals. Allowed values:
- arabic - Arabic numerals, they are used by default
- roman - Roman numerals
- eastern-arabic - Eastern Arabic numerals
- bengali - Bengali numerals
- devanagari - Devanagari numerals
- thai - Thai numerals
- east-asia - Chinese, Vietnamese, Japanese and Korean numerals
- chinese-formal - Chinese formal numerals
Please contact us if you need another type of numerals.
Example:
<span class='pdfcrowd-page-number' data-pdfcrowd-number-format='roman'></span> - data-pdfcrowd-placement - specifies where to place the source URL. Allowed values:
- The URL is inserted to the content
- Example: <span class='pdfcrowd-source-url'></span>
will produce <span>http://example.com</span>
- href - the URL is set to the href attribute
- Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href'>Link to source</a>
will produce <a href='http://example.com'>Link to source</a>
- href-and-content - the URL is set to the href attribute and to the content
- Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href-and-content'></a>
will produce <a href='http://example.com'>http://example.com</a>
Use the specified HTML code as the page header. The following classes can be used in the HTML. The content of the respective elements will be expanded as follows:
- pdfcrowd-page-count - the total page count of printed pages
- pdfcrowd-page-number - the current page number
- pdfcrowd-source-url - the source URL of the converted document
- pdfcrowd-source-title - the title of the converted document
The following attributes can be used:
- data-pdfcrowd-number-format - specifies the type of the used numerals. Allowed values:
- arabic - Arabic numerals, they are used by default
- roman - Roman numerals
- eastern-arabic - Eastern Arabic numerals
- bengali - Bengali numerals
- devanagari - Devanagari numerals
- thai - Thai numerals
- east-asia - Chinese, Vietnamese, Japanese and Korean numerals
- chinese-formal - Chinese formal numerals
Please contact us if you need another type of numerals.
Example:
<span class='pdfcrowd-page-number' data-pdfcrowd-number-format='roman'></span> - data-pdfcrowd-placement - specifies where to place the source URL. Allowed values:
- The URL is inserted to the content
- Example: <span class='pdfcrowd-source-url'></span>
will produce <span>http://example.com</span>
- href - the URL is set to the href attribute
- Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href'>Link to source</a>
will produce <a href='http://example.com'>Link to source</a>
- href-and-content - the URL is set to the href attribute and to the content
- Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href-and-content'></a>
will produce <a href='http://example.com'>http://example.com</a>
Set the file name of the header HTML document stored in the input archive. Use this method if the input archive contains multiple HTML documents.
Load an HTML code from the specified URL and use it as the page footer. The following classes can be used in the HTML. The content of the respective elements will be expanded as follows:
- pdfcrowd-page-count - the total page count of printed pages
- pdfcrowd-page-number - the current page number
- pdfcrowd-source-url - the source URL of the converted document
- pdfcrowd-source-title - the title of the converted document
The following attributes can be used:
- data-pdfcrowd-number-format - specifies the type of the used numerals. Allowed values:
- arabic - Arabic numerals, they are used by default
- roman - Roman numerals
- eastern-arabic - Eastern Arabic numerals
- bengali - Bengali numerals
- devanagari - Devanagari numerals
- thai - Thai numerals
- east-asia - Chinese, Vietnamese, Japanese and Korean numerals
- chinese-formal - Chinese formal numerals
Please contact us if you need another type of numerals.
Example:
<span class='pdfcrowd-page-number' data-pdfcrowd-number-format='roman'></span> - data-pdfcrowd-placement - specifies where to place the source URL. Allowed values:
- The URL is inserted to the content
- Example: <span class='pdfcrowd-source-url'></span>
will produce <span>http://example.com</span>
- href - the URL is set to the href attribute
- Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href'>Link to source</a>
will produce <a href='http://example.com'>Link to source</a>
- href-and-content - the URL is set to the href attribute and to the content
- Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href-and-content'></a>
will produce <a href='http://example.com'>http://example.com</a>
Use the specified HTML as the page footer. The following classes can be used in the HTML. The content of the respective elements will be expanded as follows:
- pdfcrowd-page-count - the total page count of printed pages
- pdfcrowd-page-number - the current page number
- pdfcrowd-source-url - the source URL of the converted document
- pdfcrowd-source-title - the title of the converted document
The following attributes can be used:
- data-pdfcrowd-number-format - specifies the type of the used numerals. Allowed values:
- arabic - Arabic numerals, they are used by default
- roman - Roman numerals
- eastern-arabic - Eastern Arabic numerals
- bengali - Bengali numerals
- devanagari - Devanagari numerals
- thai - Thai numerals
- east-asia - Chinese, Vietnamese, Japanese and Korean numerals
- chinese-formal - Chinese formal numerals
Please contact us if you need another type of numerals.
Example:
<span class='pdfcrowd-page-number' data-pdfcrowd-number-format='roman'></span> - data-pdfcrowd-placement - specifies where to place the source URL. Allowed values:
- The URL is inserted to the content
- Example: <span class='pdfcrowd-source-url'></span>
will produce <span>http://example.com</span>
- href - the URL is set to the href attribute
- Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href'>Link to source</a>
will produce <a href='http://example.com'>Link to source</a>
- href-and-content - the URL is set to the href attribute and to the content
- Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href-and-content'></a>
will produce <a href='http://example.com'>http://example.com</a>
Set the file name of the footer HTML document stored in the input archive. Use this method if the input archive contains multiple HTML documents.
Disable horizontal page margins for header and footer. The header/footer contents width will be equal to the physical page width.
Availability:
API client >= 5.0.0, converter >= 20.10.
See
versioning.
The page header content is not printed on the specified pages. To remove the entire header area, use the
conversion config.
The page footer content is not printed on the specified pages. To remove the entire footer area, use the
conversion config.
Set the scaling factor (zoom) for the header and footer.
Set an offset between physical and logical page numbers.
Watermark & Background
Apply a watermark to each page of the output PDF file. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark.
Constraint:
- The file must exist and not be empty.
Load a file from the specified URL and apply the file as a watermark to each page of the output PDF. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark.
Constraint:
- The supported protocols are http:// and https://.
Apply each page of a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.
Constraint:
- The file must exist and not be empty.
Load a file from the specified URL and apply each page of the file as a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.
Constraint:
- The supported protocols are http:// and https://.
Apply a background to each page of the output PDF file. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background.
Constraint:
- The file must exist and not be empty.
Load a file from the specified URL and apply the file as a background to each page of the output PDF. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background.
Constraint:
- The supported protocols are http:// and https://.
Apply each page of a background to the corresponding page of the output PDF. A background can be either a PDF or an image.
Constraint:
- The file must exist and not be empty.
-multipage-background-url
Load a file from the specified URL and apply each page of the file as a background to the corresponding page of the output PDF. A background can be either a PDF or an image.
Constraint:
- The supported protocols are http:// and https://.
The page background color in RGB or RGBA hexadecimal format. The color fills the entire page regardless of the margins.
Constraint:
- The value must be in RRGGBB or RRGGBBAA hexadecimal format.
General Options
Use the print version of the page if available (@media print).
Do not print the background graphics.
Allowed values:
-
true, 1 or on
-
false, 0 or off
Default: False
Do not execute JavaScript.
Allowed values:
-
true, 1 or on
-
false, 0 or off
Default: False
Do not load images.
Allowed values:
-
true, 1 or on
-
false, 0 or off
Default: False
Disable loading fonts from remote sources.
Allowed values:
-
true, 1 or on
-
false, 0 or off
Default: False
Use a mobile user agent.
Availability:
API client >= 5.3.0, converter >= 20.10.
See
versioning.
Allowed values:
-
true, 1 or on
-
false, 0 or off
Default: False
Specifies how iframes are handled.
Availability:
API client >= 5.0.0, converter >= 20.10.
See
versioning.
Try to block ads. Enabling this option can produce smaller output and speed up the conversion.
Allowed values:
-
true, 1 or on
-
false, 0 or off
Default: False
Set the default HTML content text encoding.
Set the locale for the conversion. This may affect the output format of dates, times and numbers.
Availability:
API client >= 5.0.0, converter >= 20.10.
See
versioning.
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.
Allowed values:
-
true, 1 or on
-
false, 0 or off
Default: False
Abort the conversion if the main URL HTTP status code is greater than or equal to 400.
Allowed values:
-
true, 1 or on
-
false, 0 or off
Default: False
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.
Allowed values:
-
true, 1 or on
-
false, 0 or off
Default: False
Do not send the X-Pdfcrowd HTTP header in Pdfcrowd HTTP requests.
Specifies behavior in presence of CSS @page rules. It may affect the page size, margins and orientation.
Availability:
API client >= 5.0.0, converter >= 20.10.
See
versioning.
Allowed values:
-
default
The Pdfcrowd API page settings are preferred.
-
mode1
The converter version 18.10 mode.
-
mode2
CSS @page rule is preferred.
Default: default
Apply custom CSS to the input HTML document. It allows you to modify the visual appearance and layout of your HTML content dynamically. Tip: Using !important in custom CSS provides a way to prioritize and override conflicting styles.
Availability:
API client >= 5.14.0, converter >= 20.10.
See
versioning.
Examples:
-
Set the page background color to gray.
"body { background-color: gray; }"
-
Do not show nav HTML elements and the element with ad-block ID in the output PDF.
"nav, #ad-block { display: none !important; }"
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.
Example:
-
Set the page background color to gray.
"document.body.style.setProperty('background-color', 'gray', 'important')"
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.
Example:
-
Set the page background color to gray.
"document.body.style.setProperty('background-color', 'gray', 'important')"
Set a custom HTTP header that is sent in Pdfcrowd HTTP requests.
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.
Constraint:
- Must be a positive integer number or 0.
Default: 200
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.
Examples:
-
The first element with the id main-content is converted.
"#main-content"
-
The first element with the class name main-content is converted.
".main-content"
-
The first element with the tag name table is converted.
"table"
-
The first element with the tag name table or with the id main-content is converted.
"table, #main-content"
-
The first element <p class="article"> within <div class="user-panel main"> is converted.
"div.user-panel.main p.article"
Specify the DOM handling when only a part of the document is converted. This can affect the CSS rules used.
Allowed 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.
Default: cut-out
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.
Examples:
-
Wait until an element with the id main-content is found.
"#main-content"
-
Wait until an element with the class name main-content is found.
".main-content"
-
Wait until an element with the tag name table is found.
"table"
-
Wait until an element with the tag name table or with the id main-content is found.
"table, #main-content"
-
Wait until <p class="article"> is found within <div class="user-panel main">.
"div.user-panel.main p.article"
-auto-detect-element-to-convert
The main HTML element for conversion is detected automatically.
Availability:
API client >= 5.5.0, converter >= 20.10.
See
versioning.
Allowed values:
-
true, 1 or on
-
false, 0 or off
Default: False
-readability-enhancements
The input HTML is automatically enhanced to improve the readability.
Availability:
API client >= 5.5.0, converter >= 20.10.
See
versioning.
Allowed 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.
Default: none
Print Resolution
Set the viewport width in pixels. The viewport is the user's visible area of the page.
Constraint:
- 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.
Constraint:
- Must be a positive integer number.
Set the rendering mode of the page, allowing control over how content is displayed.
Allowed values:
-
default
The mode based on the standard browser print functionality.
-
viewport
Adapts the rendering according to the specified viewport width, influencing the @media (min-width) and @media (max-width) CSS properties. This mode is ideal for previewing different responsive designs of a web page, such as mobile or desktop views, by choosing the appropriate viewport size.
Specifies the scaling mode used for fitting the HTML contents to the print area.
Allowed 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.
Constraint:
- The value must be in the range 10-500.
Default: 100
Disable the intelligent shrinking strategy that tries to optimally fit the HTML contents to a PDF page.
API client < 5.0.0. Smart scaling mode1 can be used instead.
See
versioning.
Allowed values:
-
true, 1 or on
-
false, 0 or off
Default: False
Set the quality of embedded JPEG images. A lower quality results in a smaller PDF file but can lead to compression artifacts.
Constraint:
- The value must be in the range 1-100.
Default: 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.
Allowed 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.
Default: none
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.
Constraint:
- Must be a positive integer number or 0.
Default: 0
Examples:
-
No change of the source image is done.
0
-
Screen-only view lower DPI.
72
-
Screen-only view recommended DPI.
96
-
Ebook typical DPI.
150
-
Printer standard DPI.
300
Miscellaneous values for PDF output.
Convert HTML forms to fillable PDF forms. Details can be found in the
blog post.
Create linearized PDF. This is also known as Fast Web View.
Allowed values:
-
true, 1 or on
-
false, 0 or off
Default: False
Encrypt the PDF. This prevents search engines from indexing the contents.
Allowed values:
-
true, 1 or on
-
false, 0 or off
Default: False
Protect the PDF with a user password. When a PDF has a user password, it must be supplied in order to view the document and to perform operations allowed by the access permissions.
Protect the PDF with an owner password. Supplying an owner password grants unlimited access to the PDF including changing the passwords and access permissions.
Disallow printing of the output PDF.
Allowed values:
-
true, 1 or on
-
false, 0 or off
Default: False
Disallow modification of the output PDF.
Allowed values:
-
true, 1 or on
-
false, 0 or off
Default: False
Disallow text and graphics extraction from the output PDF.
Allowed values:
-
true, 1 or on
-
false, 0 or off
Default: False
Set the title of the PDF.
Set the subject of the PDF.
Set the author of the PDF.
Associate keywords with the document.
Extract meta tags (author, keywords and description) from the input HTML and use them in the output PDF.
Viewer Preferences
These preferences specify how a PDF viewer should present the document. The preferences may be ignored by some PDF viewers.
Specify the page layout to be used when the document is opened.
Allowed 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.
Specify how the page should be displayed when opened.
Allowed 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.
Constraint:
- Must be a positive integer number.
Specify the initial page zoom in percents when the document is opened.
Constraint:
- 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.
Allowed values:
-
true, 1 or on
-
false, 0 or off
Default: False
Specify whether to resize the document's window to fit the size of the first displayed page.
Allowed values:
-
true, 1 or on
-
false, 0 or off
Default: False
Specify whether to position the document's window in the center of the screen.
Allowed values:
-
true, 1 or on
-
false, 0 or off
Default: False
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.
Allowed values:
-
true, 1 or on
-
false, 0 or off
Default: False
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
Allowed values:
-
true, 1 or on
-
false, 0 or off
Default: False
Data
Methods related to HTML template rendering.
Set the input data for template rendering. The data format can be JSON, XML, YAML or CSV.
Load the input data for template rendering from the specified file. The data format can be JSON, XML, YAML or CSV.
Specify the input data format.
Ignore undefined variables in the HTML template. The default mode is strict so any undefined variable causes the conversion to fail. You can use {% if variable is defined %} to check if the variable is defined.
Allowed values:
-
true, 1 or on
-
false, 0 or off
Default: False
Auto escape HTML symbols in the input data before placing them into the output.
Allowed values:
-
true, 1 or on
-
false, 0 or off
Default: False
Auto trim whitespace around each template command block.
Allowed values:
-
true, 1 or on
-
false, 0 or off
Default: False
Set the advanced data options:
- csv_delimiter - The CSV data delimiter, the default is ,.
- xml_remove_root - Remove the root XML element from the input data.
- data_root - The name of the root element inserted into the input data without a root node (e.g. CSV), the default is data.
Examples:
-
Use semicolon to separate CSV data.
"csv_delimiter=;"
-
Name the root of data rows and use the name in the template loop {% for row in rows %}...{% endfor %}.
"data_root=rows"
-
Remove XML root so it the HTML template can be more simple.
"xml_remove_root=1"
Miscellaneous
Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the
getDebugLogUrl method or available in
conversion statistics.
Allowed values:
-
true, 1 or on
-
false, 0 or off
Default: False
Tag the conversion with a custom value. The tag is used in
conversion statistics. A value longer than 32 characters is cut off.
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
Constraint:
- The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
-
"myproxy.com:8080"
-
"113.25.84.10:33333"
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
Constraint:
- The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
-
"myproxy.com:443"
-
"113.25.84.10:44333"
A client certificate to authenticate Pdfcrowd converter on your web server. The certificate is used for two-way SSL/TLS authentication and adds extra security.
Constraint:
- The file must exist and not be empty.
-client-certificate-password
A password for PKCS12 file with a client certificate if it is needed.
Tweaks
Expert options for fine-tuning output.
Set the internal DPI resolution used for positioning of PDF contents. It can help in situations when there are small inaccuracies in the PDF. It is recommended to use values that are a multiple of 72, such as 288 or 360.
Availability:
API client >= 5.0.0, converter >= 20.10.
See
versioning.
Constraint:
- The value must be in the range of 72-600.
Default: 300
Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area.
Constraint:
- The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". It may contain a negative value.
Default: 0in
Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area.
Constraint:
- The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". It may contain a negative value.
Default: 0in
Set the width of the content area. It should be at least 1 inch.
Constraint:
- The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Default: The width of the print area.
Set the height of the content area. It should be at least 1 inch.
Constraint:
- The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Default: The height of the print area.
A 2D transformation matrix applied to the main contents on each page. The origin [0,0] is located at the top-left corner of the contents. The resolution is 72 dpi.
Availability:
API client >= 5.0.0, converter >= 20.10.
See
versioning.
A 2D transformation matrix applied to the page header contents. The origin [0,0] is located at the top-left corner of the header. The resolution is 72 dpi.
Availability:
API client >= 5.0.0, converter >= 20.10.
See
versioning.
A 2D transformation matrix applied to the page footer contents. The origin [0,0] is located at the top-left corner of the footer. The resolution is 72 dpi.
Availability:
API client >= 5.0.0, converter >= 20.10.
See
versioning.
-disable-page-height-optimization
Disable automatic height adjustment that compensates for pixel to point rounding errors.
Availability:
API client >= 5.0.0, converter >= 20.10.
See
versioning.
Allowed values:
-
true, 1 or on
-
false, 0 or off
Default: False
-main-document-css-annotation
Add special CSS classes to the main document's body element. This allows applying custom styling based on these classes:
- pdfcrowd-page-X - where X is the current page number
- pdfcrowd-page-odd - odd page
- pdfcrowd-page-even - even page
Availability:
API client >= 5.0.0, converter >= 20.10.
See
versioning.
Allowed values:
-
true, 1 or on
-
false, 0 or off
Default: False
Warning
If your custom styling affects the contents area size (e.g. by using different margins, padding, border width), the resulting PDF may contain duplicit contents or some contents may be missing.
Add special CSS classes to the header/footer's body element. This allows applying custom styling based on these classes:
- pdfcrowd-page-X - where X is the current page number
- pdfcrowd-page-count-X - where X is the total page count
- pdfcrowd-page-first - the first page
- pdfcrowd-page-last - the last page
- pdfcrowd-page-odd - odd page
- pdfcrowd-page-even - even page
Availability:
API client >= 5.0.0, converter >= 20.10.
See
versioning.
Set the maximum time to load the page and its resources. After this time, all requests will be considered successful. This can be useful to ensure that the conversion does not timeout. Use this method if there is no other way to fix page loading.
Availability:
API client >= 5.15.0, converter >= 20.10.
See
versioning.
Constraint:
- The value must be in the range 10-30.
Allows to configure conversion via JSON. The configuration defines various page settings for individual PDF pages or ranges of pages. It provides flexibility in designing each page of the PDF, giving control over each page's size, header, footer etc. If a page or parameter is not explicitly specified, the system will use the default settings for that page or attribute. If a JSON configuration is provided, the settings in the JSON will take precedence over the global options.
The structure of the JSON must be:
- pageSetup: An array of objects where each object defines the configuration for a specific page or range of pages. The following properties can be set for each page object:
-
pages:
A comma-separated list of page numbers or ranges.
Special strings may be used, such as `odd`, `even` and `last`.
For example:
- 1-: from page 1 to the end of the document
- 2: only the 2nd page
- 2,4,6: pages 2, 4, and 6
- 2-5: pages 2 through 5
- odd,2: the 2nd page and all odd pages
- pageSize: The page size (optional).
Possible values: A0, A1, A2, A3, A4, A5, A6, Letter.
- pageWidth: The width of the page (optional).
- pageHeight: The height of the page (optional).
- marginLeft: Left margin (optional).
- marginRight: Right margin (optional).
- marginTop: Top margin (optional).
- marginBottom: Bottom margin (optional).
-
displayHeader: Header appearance (optional). Possible values:
- none: completely excluded
- space: only the content is excluded, the space is used
- content: the content is printed (default)
-
displayFooter: Footer appearance (optional). Possible values:
- none: completely excluded
- space: only the content is excluded, the space is used
- content: the content is printed (default)
- headerHeight: Height of the header (optional).
- footerHeight: Height of the footer (optional).
- orientation: Page orientation, such as "portrait" or "landscape" (optional).
Dimensions may be empty, 0 or specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Availability:
API client >= 6.1.0, converter >= 24.04.
See
versioning.
Allows to configure the conversion process via JSON file. See details of the
JSON string.
Availability:
API client >= 6.1.0, converter >= 24.04.
See
versioning.
Constraint:
- The file must exist and not be empty.