API Method Index

Methods

Method Name Converter API Clients
addPdfFile() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Add a PDF file to the list of the input PDFs.
addPdfRawData() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Add in-memory raw PDF data to the list of the input PDFs.
Typical usage is for adding PDF created by another Pdfcrowd converter.
convert() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Perform an action on the input files.
convertFile() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Convert a local file.
convertFile() HTML to Image PHP Java .NET Python Node.js Ruby Go
Convert a local file.
convertFile() Image to Image PHP Java .NET Python Node.js Ruby Go
Convert a local file.
convertFile() Image to PDF PHP Java .NET Python Node.js Ruby Go
Convert a local file.
convertFileToFile() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Convert a local file and write the result to a local file.
convertFileToFile() HTML to Image PHP Java .NET Python Node.js Ruby Go
Convert a local file and write the result to a local file.
convertFileToFile() Image to Image PHP Java .NET Python Node.js Ruby Go
Convert a local file and write the result to a local file.
convertFileToFile() Image to PDF PHP Java .NET Python Node.js Ruby Go
Convert a local file and write the result to a local file.
convertFileToStream() HTML to PDF PHP Java .NET Python Ruby Go
Convert a local file and write the result to an output stream.
convertFileToStream() HTML to Image PHP Java .NET Python Ruby Go
Convert a local file and write the result to an output stream.
convertFileToStream() Image to Image PHP Java .NET Python Ruby Go
Convert a local file and write the result to an output stream.
convertFileToStream() Image to PDF PHP Java .NET Python Ruby Go
Convert a local file and write the result to an output stream.
convertRawData() Image to Image PHP Java .NET Python Node.js Ruby Go
Convert raw data.
convertRawData() Image to PDF PHP Java .NET Python Node.js Ruby Go
Convert raw data.
convertRawDataToFile() Image to Image PHP Java .NET Python Node.js Ruby Go
Convert raw data to a file.
convertRawDataToFile() Image to PDF PHP Java .NET Python Node.js Ruby Go
Convert raw data to a file.
convertRawDataToStream() Image to Image PHP Java .NET Python Ruby Go
Convert raw data and write the result to an output stream.
convertRawDataToStream() Image to PDF PHP Java .NET Python Ruby Go
Convert raw data and write the result to an output stream.
convertStream() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Convert the contents of an input stream.
convertStream() HTML to Image PHP Java .NET Python Node.js Ruby Go
Convert the contents of an input stream.
convertStream() Image to Image PHP Java .NET Python Node.js Ruby Go
Convert the contents of an input stream.
convertStream() Image to PDF PHP Java .NET Python Node.js Ruby Go
Convert the contents of an input stream.
convertStreamToFile() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Convert the contents of an input stream and write the result to a local file.
convertStreamToFile() HTML to Image PHP Java .NET Python Node.js Ruby Go
Convert the contents of an input stream and write the result to a local file.
convertStreamToFile() Image to Image PHP Java .NET Python Node.js Ruby Go
Convert the contents of an input stream and write the result to a local file.
convertStreamToFile() Image to PDF PHP Java .NET Python Node.js Ruby Go
Convert the contents of an input stream and write the result to a local file.
convertStreamToStream() HTML to PDF PHP Java .NET Python Ruby Go
Convert the contents of an input stream and write the result to an output stream.
convertStreamToStream() HTML to Image PHP Java .NET Python Ruby Go
Convert the contents of an input stream and write the result to an output stream.
convertStreamToStream() Image to Image PHP Java .NET Python Ruby Go
Convert the contents of an input stream and write the result to an output stream.
convertStreamToStream() Image to PDF PHP Java .NET Python Ruby Go
Convert the contents of an input stream and write the result to an output stream.
convertString() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Convert a string.
convertString() HTML to Image PHP Java .NET Python Node.js Ruby Go
Convert a string.
convertStringToFile() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Convert a string and write the output to a file.
convertStringToFile() HTML to Image PHP Java .NET Python Node.js Ruby Go
Convert a string and write the output to a file.
convertStringToStream() HTML to PDF PHP Java .NET Python Ruby Go
Convert a string and write the output to an output stream.
convertStringToStream() HTML to Image PHP Java .NET Python Ruby Go
Convert a string and write the output to an output stream.
convertToFile() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Perform an action on the input files and write the output PDF to a file.
convertToStream() PDF to PDF PHP Java .NET Python Ruby Go
Perform an action on the input files and write the output PDF to an output stream.
convertUrl() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Convert a web page.
convertUrl() HTML to Image PHP Java .NET Python Node.js Ruby Go
Convert a web page.
convertUrl() Image to Image PHP Java .NET Python Node.js Ruby Go
Convert an image.
convertUrl() Image to PDF PHP Java .NET Python Node.js Ruby Go
Convert an image.
convertUrlToFile() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Convert a web page and write the result to a local file.
convertUrlToFile() HTML to Image PHP Java .NET Python Node.js Ruby Go
Convert a web page and write the result to a local file.
convertUrlToFile() Image to Image PHP Java .NET Python Node.js Ruby Go
Convert an image and write the result to a local file.
convertUrlToFile() Image to PDF PHP Java .NET Python Node.js Ruby Go
Convert an image and write the result to a local file.
convertUrlToStream() HTML to PDF PHP Java .NET Python Ruby Go
Convert a web page and write the result to an output stream.
convertUrlToStream() HTML to Image PHP Java .NET Python Ruby Go
Convert a web page and write the result to an output stream.
convertUrlToStream() Image to Image PHP Java .NET Python Ruby Go
Convert an image and write the result to an output stream.
convertUrlToStream() Image to PDF PHP Java .NET Python Ruby Go
Convert an image and write the result to an output stream.
getConsumedCreditCount() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Get the number of credits consumed by the last conversion.
getConsumedCreditCount() HTML to Image PHP Java .NET Python Node.js Ruby Go
Get the number of credits consumed by the last conversion.
getConsumedCreditCount() Image to Image PHP Java .NET Python Node.js Ruby Go
Get the number of credits consumed by the last conversion.
getConsumedCreditCount() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Get the number of credits consumed by the last conversion.
getConsumedCreditCount() Image to PDF PHP Java .NET Python Node.js Ruby Go
Get the number of credits consumed by the last conversion.
getDebugLogUrl() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Get the URL of the debug log for the last conversion.
getDebugLogUrl() HTML to Image PHP Java .NET Python Node.js Ruby Go
Get the URL of the debug log for the last conversion.
getDebugLogUrl() Image to Image PHP Java .NET Python Node.js Ruby Go
Get the URL of the debug log for the last conversion.
getDebugLogUrl() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Get the URL of the debug log for the last conversion.
getDebugLogUrl() Image to PDF PHP Java .NET Python Node.js Ruby Go
Get the URL of the debug log for the last conversion.
getJobId() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Get the job id.
getJobId() HTML to Image PHP Java .NET Python Node.js Ruby Go
Get the job id.
getJobId() Image to Image PHP Java .NET Python Node.js Ruby Go
Get the job id.
getJobId() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Get the job id.
getJobId() Image to PDF PHP Java .NET Python Node.js Ruby Go
Get the job id.
getOutputSize() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Get the size of the output in bytes.
getOutputSize() HTML to Image PHP Java .NET Python Node.js Ruby Go
Get the size of the output in bytes.
getOutputSize() Image to Image PHP Java .NET Python Node.js Ruby Go
Get the size of the output in bytes.
getOutputSize() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Get the size of the output in bytes.
getOutputSize() Image to PDF PHP Java .NET Python Node.js Ruby Go
Get the size of the output in bytes.
getPageCount() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Get the total number of pages in the output document.
getPageCount() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Get the total number of pages in the output document.
getRemainingCreditCount() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Get the number of conversion credits available in your account.
This method can only be called after a call to one of the convertXYZ methods.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.
getRemainingCreditCount() HTML to Image PHP Java .NET Python Node.js Ruby Go
Get the number of conversion credits available in your account.
This method can only be called after a call to one of the convertXYZ methods.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.
getRemainingCreditCount() Image to Image PHP Java .NET Python Node.js Ruby Go
Get the number of conversion credits available in your account.
This method can only be called after a call to one of the convertXYZ methods.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.
getRemainingCreditCount() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Get the number of conversion credits available in your account.
This method can only be called after a call to one of the convertXYZ methods.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.
getRemainingCreditCount() Image to PDF PHP Java .NET Python Node.js Ruby Go
Get the number of conversion credits available in your account.
This method can only be called after a call to one of the convertXYZ methods.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.
getVersion() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Get the version details.
getVersion() HTML to Image PHP Java .NET Python Node.js Ruby Go
Get the version details.
getVersion() Image to Image PHP Java .NET Python Node.js Ruby Go
Get the version details.
getVersion() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Get the version details.
getVersion() Image to PDF PHP Java .NET Python Node.js Ruby Go
Get the version details.
setAction() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Specifies the action to be performed on the input PDFs.
setAuthor() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the author of the PDF.
setAuthor() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Set the author of the PDF.
setBackgroundColor() HTML to Image PHP Java .NET Python Node.js Ruby Go
The output image background color.
setBlockAds() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Try to block ads. Enabling this option can produce smaller output and speed up the conversion.
setBlockAds() HTML to Image PHP Java .NET Python Node.js Ruby Go
Try to block ads. Enabling this option can produce smaller output and speed up the conversion.
setCenterWindow() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Specify whether to position the document's window in the center of the screen.
setCenterWindow() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Specify whether to position the document's window in the center of the screen.
setClientCertificate() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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.
setClientCertificate() HTML to Image PHP Java .NET Python Node.js Ruby Go
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.
setClientCertificatePassword() HTML to PDF PHP Java .NET Python Node.js Ruby Go
A password for PKCS12 file with a client certificate if it is needed.
setClientCertificatePassword() HTML to Image PHP Java .NET Python Node.js Ruby Go
A password for PKCS12 file with a client certificate if it is needed.
setContentArea() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the content area position and size. The content area enables to specify a web page area to be converted.
setContentAreaHeight() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the height of the content area. It should be at least 1 inch.
setContentAreaWidth() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the width of the content area. It should be at least 1 inch.
setContentAreaX() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area.
setContentAreaY() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area.
setContentsMatrix() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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.
setConvertImagesToJpeg() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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.
setConverterVersion() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.
setConverterVersion() HTML to Image PHP Java .NET Python Node.js Ruby Go
Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.
setConverterVersion() Image to Image PHP Java .NET Python Node.js Ruby Go
Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.
setConverterVersion() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.
setConverterVersion() Image to PDF PHP Java .NET Python Node.js Ruby Go
Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.
setCookies() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set cookies that are sent in Pdfcrowd HTTP requests.
setCookies() HTML to Image PHP Java .NET Python Node.js Ruby Go
Set cookies that are sent in Pdfcrowd HTTP requests.
setCssPageRuleMode() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Specifies behavior in presence of CSS @page rules. It may affect the page size, margins and orientation.
setCustomHttpHeader() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set a custom HTTP header that is sent in Pdfcrowd HTTP requests.
setCustomHttpHeader() HTML to Image PHP Java .NET Python Node.js Ruby Go
Set a custom HTTP header that is sent in Pdfcrowd HTTP requests.
setCustomJavascript() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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.
setCustomJavascript() HTML to Image PHP Java .NET Python Node.js Ruby Go
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.
setDataAutoEscape() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Auto escape HTML symbols in the input data before placing them into the output.
setDataAutoEscape() HTML to Image PHP Java .NET Python Node.js Ruby Go
Auto escape HTML symbols in the input data before placing them into the output.
setDataEncoding() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the encoding of the data file set by setDataFile.
setDataEncoding() HTML to Image PHP Java .NET Python Node.js Ruby Go
Set the encoding of the data file set by setDataFile.
setDataFile() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Load the input data for template rendering from the specified file. The data format can be JSON, XML, YAML or CSV.
setDataFile() HTML to Image PHP Java .NET Python Node.js Ruby Go
Load the input data for template rendering from the specified file. The data format can be JSON, XML, YAML or CSV.
setDataFormat() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Specify the input data format.
setDataFormat() HTML to Image PHP Java .NET Python Node.js Ruby Go
Specify the input data format.
setDataIgnoreUndefined() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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.
setDataIgnoreUndefined() HTML to Image PHP Java .NET Python Node.js Ruby Go
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.
setDataOptions() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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.
setDataOptions() HTML to Image PHP Java .NET Python Node.js Ruby Go
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.
setDataString() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the input data for template rendering. The data format can be JSON, XML, YAML or CSV.
setDataString() HTML to Image PHP Java .NET Python Node.js Ruby Go
Set the input data for template rendering. The data format can be JSON, XML, YAML or CSV.
setDataTrimBlocks() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Auto trim whitespace around each template command block.
setDataTrimBlocks() HTML to Image PHP Java .NET Python Node.js Ruby Go
Auto trim whitespace around each template command block.
setDebugLog() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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.
setDebugLog() HTML to Image PHP Java .NET Python Node.js Ruby Go
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.
setDebugLog() Image to Image PHP Java .NET Python Node.js Ruby Go
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.
setDebugLog() PDF to PDF PHP Java .NET Python Node.js Ruby Go
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.
setDebugLog() Image to PDF PHP Java .NET Python Node.js Ruby Go
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.
setDefaultEncoding() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the default HTML content text encoding.
setDefaultEncoding() HTML to Image PHP Java .NET Python Node.js Ruby Go
Set the default HTML content text encoding.
setDisableImageLoading() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Do not load images.
setDisableImageLoading() HTML to Image PHP Java .NET Python Node.js Ruby Go
Do not load images.
setDisableJavascript() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Do not execute JavaScript.
setDisableJavascript() HTML to Image PHP Java .NET Python Node.js Ruby Go
Do not execute JavaScript.
setDisablePageHeightOptimization() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Disable automatic height adjustment that compensates for pixel to point rounding errors.
setDisableRemoteFonts() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Disable loading fonts from remote sources.
setDisableRemoteFonts() HTML to Image PHP Java .NET Python Node.js Ruby Go
Disable loading fonts from remote sources.
setDisableSmartShrinking() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Disable the intelligent shrinking strategy that tries to optimally fit the HTML contents to a PDF page.
setDisplayTitle() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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.
setDisplayTitle() PDF to PDF PHP Java .NET Python Node.js Ruby Go
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.
setElementToConvert() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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.
setElementToConvert() HTML to Image PHP Java .NET Python Node.js Ruby Go
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.
setElementToConvertMode() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Specify the DOM handling when only a part of the document is converted. This can affect the CSS rules used.
setElementToConvertMode() HTML to Image PHP Java .NET Python Node.js Ruby Go
Specify the DOM handling when only a part of the document is converted. This can affect the CSS rules used.
setEncrypt() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Encrypt the PDF. This prevents search engines from indexing the contents.
setEncrypt() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Encrypt the PDF. This prevents search engines from indexing the contents.
setExcludeFooterOnPages() HTML to PDF PHP Java .NET Python Node.js Ruby Go
The page footer is not printed on the specified pages.
setExcludeHeaderOnPages() HTML to PDF PHP Java .NET Python Node.js Ruby Go
The page header is not printed on the specified pages.
setExtractMetaTags() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Extract meta tags (author, keywords and description) from the input HTML and use them in the output PDF.
setFailOnAnyUrlError() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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.
setFailOnAnyUrlError() HTML to Image PHP Java .NET Python Node.js Ruby Go
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.
setFailOnMainUrlError() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Abort the conversion if the main URL HTTP status code is greater than or equal to 400.
setFailOnMainUrlError() HTML to Image PHP Java .NET Python Node.js Ruby Go
Abort the conversion if the main URL HTTP status code is greater than or equal to 400.
setFitWindow() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Specify whether to resize the document's window to fit the size of the first displayed page.
setFitWindow() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Specify whether to resize the document's window to fit the size of the first displayed page.
setFooterHeight() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the footer height.
setFooterHtml() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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 a 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>
setFooterMatrix() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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.
setFooterUrl() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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 a 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>
setHeaderFooterCssAnnotation() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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
setHeaderFooterScaleFactor() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the scaling factor (zoom) for the header and footer.
setHeaderHeight() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the header height.
setHeaderHtml() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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 a 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>
setHeaderMatrix() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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.
setHeaderUrl() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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 a 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>
setHideMenubar() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Specify whether to hide the viewer application's menu bar when the document is active.
setHideMenubar() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Specify whether to hide the viewer application's menu bar when the document is active.
setHideToolbar() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Specify whether to hide the viewer application's tool bars when the document is active.
setHideToolbar() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Specify whether to hide the viewer application's tool bars when the document is active.
setHideWindowUi() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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.
setHideWindowUi() PDF to PDF PHP Java .NET Python Node.js Ruby Go
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.
setHttpAuth() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set credentials to access HTTP base authentication protected websites.
setHttpAuth() HTML to Image PHP Java .NET Python Node.js Ruby Go
Set credentials to access HTTP base authentication protected websites.
setHttpProxy() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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.
setHttpProxy() HTML to Image PHP Java .NET Python Node.js Ruby Go
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.
setHttpProxy() Image to Image PHP Java .NET Python Node.js Ruby Go
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.
setHttpProxy() Image to PDF PHP Java .NET Python Node.js Ruby Go
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.
setHttpsProxy() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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.
setHttpsProxy() HTML to Image PHP Java .NET Python Node.js Ruby Go
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.
setHttpsProxy() Image to Image PHP Java .NET Python Node.js Ruby Go
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.
setHttpsProxy() Image to PDF PHP Java .NET Python Node.js Ruby Go
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.
setImageDpi() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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.
setInitialPage() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Display the specified page when the document is opened.
setInitialPage() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Display the specified page when the document is opened.
setInitialZoom() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Specify the initial page zoom in percents when the document is opened.
setInitialZoom() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Specify the initial page zoom in percents when the document is opened.
setInitialZoomType() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Specify how the page should be displayed when opened.
setInitialZoomType() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Specify how the page should be displayed when opened.
setJavascriptDelay() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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.
setJavascriptDelay() HTML to Image PHP Java .NET Python Node.js Ruby Go
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.
setJpegQuality() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the quality of embedded JPEG images. A lower quality results in a smaller PDF file but can lead to compression artifacts.
setKeywords() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Associate keywords with the document.
setKeywords() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Associate keywords with the document.
setLayoutDpi() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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.
setLinearize() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Create linearized PDF. This is also known as Fast Web View.
setLinearize() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Create linearized PDF. This is also known as Fast Web View.
setLoadIframes() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Specifies how iframes are handled.
setLoadIframes() HTML to Image PHP Java .NET Python Node.js Ruby Go
Specifies how iframes are handled.
setLocale() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the locale for the conversion. This may affect the output format of dates, times and numbers.
setLocale() HTML to Image PHP Java .NET Python Node.js Ruby Go
Set the locale for the conversion. This may affect the output format of dates, times and numbers.
setMainDocumentCssAnnotation() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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
setMarginBottom() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the output page bottom margin.
setMarginLeft() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the output page left margin.
setMarginRight() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the output page right margin.
setMarginTop() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the output page top margin.
setMultipageBackground() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Apply each page of the specified PDF to the background of the corresponding page of the output PDF.
setMultipageBackground() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Apply each page of the specified PDF to the background of the corresponding page of the output PDF.
setMultipageBackgroundUrl() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Load a background PDF from the specified URL and apply each page of the specified background PDF to the corresponding page of the output PDF.
setMultipageBackgroundUrl() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Load a background PDF from the specified URL and apply each page of the specified background PDF to the corresponding page of the output PDF.
setMultipageWatermark() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Apply each page of the specified watermark PDF to the corresponding page of the output PDF.
setMultipageWatermark() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Apply each page of the specified watermark PDF to the corresponding page of the output PDF.
setMultipageWatermarkUrl() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Load a watermark PDF from the specified URL and apply each page of the specified watermark PDF to the corresponding page of the output PDF.
setMultipageWatermarkUrl() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Load a watermark PDF from the specified URL and apply each page of the specified watermark PDF to the corresponding page of the output PDF.
setNoBackground() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Do not print the background graphics.
setNoBackground() HTML to Image PHP Java .NET Python Node.js Ruby Go
Do not print the background graphics.
setNoCopy() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Disallow text and graphics extraction from the output PDF.
setNoCopy() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Disallow text and graphics extraction from the output PDF.
setNoHeaderFooterHorizontalMargins() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Disable horizontal page margins for header and footer. The header/footer contents width will be equal to the physical page width.
setNoMargins() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Disable page margins.
setNoModify() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Disallow modification of the output PDF.
setNoModify() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Disallow modification of the output PDF.
setNoPrint() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Disallow printing of the output PDF.
setNoPrint() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Disallow printing of the output PDF.
setNoXpdfcrowdHeader() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Do not send the X-Pdfcrowd HTTP header in Pdfcrowd HTTP requests.
setNoXpdfcrowdHeader() HTML to Image PHP Java .NET Python Node.js Ruby Go
Do not send the X-Pdfcrowd HTTP header in Pdfcrowd HTTP requests.
setOnLoadJavascript() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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.
setOnLoadJavascript() HTML to Image PHP Java .NET Python Node.js Ruby Go
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.
setOrientation() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the output page orientation.
setOutputFormat() HTML to Image PHP Java .NET Python Node.js Ruby Go
The format of the output file.
setOutputFormat() Image to Image PHP Java .NET Python Node.js Ruby Go
The format of the output file.
setOwnerPassword() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Protect the PDF with an owner password. Supplying an owner password grants unlimited access to the PDF including changing the passwords and access permissions.
setOwnerPassword() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Protect the PDF with an owner password. Supplying an owner password grants unlimited access to the PDF including changing the passwords and access permissions.
setPageBackground() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Apply the first page of the specified PDF to the background of every page of the output PDF.
setPageBackground() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Apply the first page of the specified PDF to the background of every page of the output PDF.
setPageBackgroundColor() HTML to PDF PHP Java .NET Python Node.js Ruby Go
The page background color in RGB or RGBA hexadecimal format. The color fills the entire page regardless of the margins.
setPageBackgroundUrl() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Load a background PDF from the specified URL and apply the first page of the background PDF to every page of the output PDF.
setPageBackgroundUrl() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Load a background PDF from the specified URL and apply the first page of the background PDF to every page of the output PDF.
setPageDimensions() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the output page dimensions.
setPageHeight() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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.
setPageLayout() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Specify the page layout to be used when the document is opened.
setPageLayout() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Specify the page layout to be used when the document is opened.
setPageMargins() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the output page margins.
setPageMode() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Specify how the document should be displayed when opened.
setPageMode() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Specify how the document should be displayed when opened.
setPageNumberingOffset() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set an offset between physical and logical page numbers.
setPageSize() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the output page size.
setPageWatermark() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Apply the first page of the watermark PDF to every page of the output PDF.
setPageWatermark() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Apply the first page of the watermark PDF to every page of the output PDF.
setPageWatermarkUrl() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Load a watermark PDF from the specified URL and apply the first page of the watermark PDF to every page of the output PDF.
setPageWatermarkUrl() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Load a watermark PDF from the specified URL and apply the first page of the watermark PDF to every page of the output PDF.
setPageWidth() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the output page width. The safe maximum is 200in otherwise some PDF viewers may be unable to open the PDF.
setPrintPageRange() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the page range to print.
setProxy() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Specifies an HTTP proxy that the API client library will use to connect to the internet.
setProxy() HTML to Image PHP Java .NET Python Node.js Ruby Go
Specifies an HTTP proxy that the API client library will use to connect to the internet.
setProxy() Image to Image PHP Java .NET Python Node.js Ruby Go
Specifies an HTTP proxy that the API client library will use to connect to the internet.
setProxy() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Specifies an HTTP proxy that the API client library will use to connect to the internet.
setProxy() Image to PDF PHP Java .NET Python Node.js Ruby Go
Specifies an HTTP proxy that the API client library will use to connect to the internet.
setRenderingMode() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the rendering mode.
setResize() Image to Image PHP Java .NET Python Node.js Ruby Go
Resize the image.
setResize() Image to PDF PHP Java .NET Python Node.js Ruby Go
Resize the image.
setRetryCount() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Specifies the number of retries when the 502 HTTP status code is received. The 502 status code indicates a temporary network issue. This feature can be disabled by setting to 0.
setRetryCount() HTML to Image PHP Java .NET Python Node.js Ruby Go
Specifies the number of retries when the 502 HTTP status code is received. The 502 status code indicates a temporary network issue. This feature can be disabled by setting to 0.
setRetryCount() Image to Image PHP Java .NET Python Node.js Ruby Go
Specifies the number of retries when the 502 HTTP status code is received. The 502 status code indicates a temporary network issue. This feature can be disabled by setting to 0.
setRetryCount() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Specifies the number of retries when the 502 HTTP status code is received. The 502 status code indicates a temporary network issue. This feature can be disabled by setting to 0.
setRetryCount() Image to PDF PHP Java .NET Python Node.js Ruby Go
Specifies the number of retries when the 502 HTTP status code is received. The 502 status code indicates a temporary network issue. This feature can be disabled by setting to 0.
setRightToLeft() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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
setRightToLeft() PDF to PDF PHP Java .NET Python Node.js Ruby Go
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
setRotate() Image to Image PHP Java .NET Python Node.js Ruby Go
Rotate the image.
setRotate() Image to PDF PHP Java .NET Python Node.js Ruby Go
Rotate the image.
setScaleFactor() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the scaling factor (zoom) for the main page area.
setScaleFactor() HTML to Image PHP Java .NET Python Node.js Ruby Go
Set the scaling factor (zoom) for the output image.
setScreenshotHeight() HTML to Image PHP Java .NET Python Node.js Ruby Go
Set the output image height in pixels. If it is not specified, actual document height is used.
setScreenshotWidth() HTML to Image PHP Java .NET Python Node.js Ruby Go
Set the output image width in pixels.
setSmartScalingMode() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Specifies the scaling mode used for fitting the HTML contents to the print area.
setSubject() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the subject of the PDF.
setSubject() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Set the subject of the PDF.
setTag() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
setTag() HTML to Image PHP Java .NET Python Node.js Ruby Go
Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
setTag() Image to Image PHP Java .NET Python Node.js Ruby Go
Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
setTag() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
setTag() Image to PDF PHP Java .NET Python Node.js Ruby Go
Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
setTitle() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the title of the PDF.
setTitle() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Set the title of the PDF.
setUseCurl() HTML to PDF PHP
Use cURL for the conversion request instead of the file_get_contents() PHP function.
setUseCurl() HTML to Image PHP
Use cURL for the conversion request instead of the file_get_contents() PHP function.
setUseCurl() Image to Image PHP
Use cURL for the conversion request instead of the file_get_contents() PHP function.
setUseCurl() PDF to PDF PHP
Use cURL for the conversion request instead of the file_get_contents() PHP function.
setUseCurl() Image to PDF PHP
Use cURL for the conversion request instead of the file_get_contents() PHP function.
setUseHttp() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
setUseHttp() HTML to Image PHP Java .NET Python Node.js Ruby Go
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
setUseHttp() Image to Image PHP Java .NET Python Node.js Ruby Go
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
setUseHttp() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
setUseHttp() Image to PDF PHP Java .NET Python Node.js Ruby Go
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
setUseMetadataFrom() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Use metadata (title, subject, author and keywords) from the n-th input PDF.
setUsePrintMedia() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Use the print version of the page if available (@media print).
setUsePrintMedia() HTML to Image PHP Java .NET Python Node.js Ruby Go
Use the print version of the page if available (@media print).
setUserAgent() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set a custom user agent HTTP header. It can be useful if you are behind some proxy or firewall.
setUserAgent() HTML to Image PHP Java .NET Python Node.js Ruby Go
Set a custom user agent HTTP header. It can be useful if you are behind some proxy or firewall.
setUserAgent() Image to Image PHP Java .NET Python Node.js Ruby Go
Set a custom user agent HTTP header. It can be useful if you are behind some proxy or firewall.
setUserAgent() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Set a custom user agent HTTP header. It can be useful if you are behind some proxy or firewall.
setUserAgent() Image to PDF PHP Java .NET Python Node.js Ruby Go
Set a custom user agent HTTP header. It can be useful if you are behind some proxy or firewall.
setUserPassword() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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.
setUserPassword() PDF to PDF PHP Java .NET Python Node.js Ruby Go
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.
setVerifySslCertificates() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Do not allow insecure HTTPS connections.
setVerifySslCertificates() HTML to Image PHP Java .NET Python Node.js Ruby Go
Do not allow insecure HTTPS connections.
setViewport() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the viewport size. The viewport is the user's visible area of the page.
setViewportHeight() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the viewport height in pixels. The viewport is the user's visible area of the page.
setViewportWidth() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the viewport width in pixels. The viewport is the user's visible area of the page.
setWaitForElement() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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.
setWaitForElement() HTML to Image PHP Java .NET Python Node.js Ruby Go
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.
setZipFooterFilename() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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.
setZipHeaderFilename() HTML to PDF PHP Java .NET Python Node.js Ruby Go
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.
setZipMainFilename() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the file name of the main HTML document stored in the input archive. If not specified, the first HTML file in the archive is used for conversion. Use this method if the input archive contains multiple HTML documents.
setZipMainFilename() HTML to Image PHP Java .NET Python Node.js Ruby Go
Set the file name of the main HTML document stored in the input archive. If not specified, the first HTML file in the archive is used for conversion. Use this method if the input archive contains multiple HTML documents.