Image to PDF / Ruby Reference

class ImageToPdfClient

All setter methods return ImageToPdfClient object unless specified otherwise.

Constructor

def initialize(user_name, api_key)
Constructor for the Pdfcrowd API client.
user_name
Your username at Pdfcrowd.
api_key
Your API key.

Conversion Input

def convertUrl(url)
Convert an image.
url
The address of the image to convert.
Supported protocols are http:// and https://.
Returns
  • byte[] - Byte array containing the conversion output. 
def convertUrlToStream(url, out_stream)
Convert an image and write the result to an output stream.
url
The address of the image to convert.
Supported protocols are http:// and https://.
out_stream
The output stream that will contain the conversion output. 
def convertUrlToFile(url, file_path)
Convert an image and write the result to a local file.
url
The address of the image to convert.
Supported protocols are http:// and https://.
file_path
The output file path. 
def convertFile(file)
Convert a local file.
file
The path to a local file to convert.
The file must exist and not be empty.
Returns
  • byte[] - Byte array containing the conversion output. 
def convertFileToStream(file, out_stream)
Convert a local file and write the result to an output stream.
file
The path to a local file to convert.
The file must exist and not be empty.
out_stream
The output stream that will contain the conversion output. 
def convertFileToFile(file, file_path)
Convert a local file and write the result to a local file.
file
The path to a local file to convert.
The file must exist and not be empty.
file_path
The output file path. 
def convertRawData(data)
Convert raw data.
data
The raw content to be converted.
Returns
  • byte[] - Byte array with the output. 
def convertRawDataToStream(data, out_stream)
Convert raw data and write the result to an output stream.
data
The raw content to be converted.
out_stream
The output stream that will contain the conversion output. 
def convertRawDataToFile(data, file_path)
Convert raw data to a file.
data
The raw content to be converted.
file_path
The output file path. 
def convertStream(in_stream)
Convert the contents of an input stream.
in_stream
The input stream with source data.
Returns
  • byte[] - Byte array containing the conversion output. 
def convertStreamToStream(in_stream, out_stream)
Convert the contents of an input stream and write the result to an output stream.
in_stream
The input stream with source data.
out_stream
The output stream that will contain the conversion output. 
def convertStreamToFile(in_stream, file_path)
Convert the contents of an input stream and write the result to a local file.
in_stream
The input stream with source data.
file_path
The output file path.

Image Operations

Settings used for operations with images.

def setResize(resize)
Resize the image.
resize
The resize percentage or new image dimensions.
Default: 100%
Examples:
  • setResize("200%")
  • setResize("1024x768") 
def setRotate(rotate)
Rotate the image.
rotate
The rotation specified in degrees.
Default: 0 
def setCropAreaX(x)
Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area.
x
The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Default: 0px
Examples:
  • setCropAreaX("-1in")
  • setCropAreaX("2.5cm") 
def setCropAreaY(y)
Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area.
y
The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Default: 0px
Examples:
  • setCropAreaY("-1in")
  • setCropAreaY("2.5cm") 
def setCropAreaWidth(width)
Set the width of the content area. It should be at least 1 inch.
width
The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Default: The width of the print area.
Examples:
  • setCropAreaWidth("8in")
  • setCropAreaWidth("25cm") 
def setCropAreaHeight(height)
Set the height of the content area. It should be at least 1 inch.
height
The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Default: The height of the print area.
Examples:
  • setCropAreaHeight("8in")
  • setCropAreaHeight("25cm") 
def setCropArea(x, y, width, height)
Set the content area position and size. The content area enables to specify the part to be converted.
x
Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area.
The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Default: 0px
y
Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area.
The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Default: 0px
width
Set the width of the content area. It should be at least 1 inch.
The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Default: The width of the print area.
height
Set the height of the content area. It should be at least 1 inch.
The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Default: The height of the print area. 
def setRemoveBorders(value)
Remove borders of an image which does not change in color.
value
Set to true to remove borders.
Default: false

Page Setup

def setPageSize(size)
Set the output page size.
size
Allowed values:
  • A0
  • A1
  • A2
  • A3
  • A4
  • A5
  • A6
  • Letter
def setPageWidth(width)
Set the output page width.
width
The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Examples:
  • setPageWidth("300mm")
  • setPageWidth("9.5in") 
def setPageHeight(height)
Set the output page height.
height
The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Examples:
  • setPageHeight("15.25in")
  • setPageHeight("350mm") 
def setPageDimensions(width, height)
Set the output page dimensions. If no page size is specified, margins are applied as a border around the image.
width
Set the output page width.
The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
height
Set the output page height.
The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Examples:
  • setPageDimensions("300mm", "350mm")
  • setPageDimensions("9.5in", "15.25in")
  • setPageDimensions("372mm", "520pt") 
def setOrientation(orientation)
Set the output page orientation.
orientation
Allowed values:
  • landscape
  • portrait
Default: portrait 
def setPosition(position)
Set the image position on the page.
position
Allowed values:
  • center
  • top
  • bottom
  • left
  • right
  • top-left
  • top-right
  • bottom-left
  • bottom-right
Default: center 
def setPrintPageMode(mode)
Set the mode to print the image on the content area of the page.
mode
Allowed values:
  • default
    No image scaling.
  • fit
    Fit image to page with aspect ratio.
  • stretch
    Stretch image to the page with no aspect ratio.
Default: default 
def setMarginTop(top)
Set the output page top margin.
top
The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Examples:
  • setMarginTop("1in")
  • setMarginTop("2.5cm") 
def setMarginRight(right)
Set the output page right margin.
right
The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Examples:
  • setMarginRight("1in")
  • setMarginRight("2.5cm") 
def setMarginBottom(bottom)
Set the output page bottom margin.
bottom
The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Examples:
  • setMarginBottom("1in")
  • setMarginBottom("2.5cm") 
def setMarginLeft(left)
Set the output page left margin.
left
The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Examples:
  • setMarginLeft("1in")
  • setMarginLeft("2.5cm") 
def setPageMargins(top, right, bottom, left)
Set the output page margins.
top
Set the output page top margin.
The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
right
Set the output page right margin.
The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
bottom
Set the output page bottom margin.
The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
left
Set the output page left margin.
The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
def setPageBackgroundColor(color)
The page background color in RGB or RGBA hexadecimal format. The color fills the entire page regardless of the margins. If not page size is specified and the image format supports background (e.g. PDF, PNG), the background color is applied too.
color
The value must be in RRGGBB or RRGGBBAA hexadecimal format.
Examples:
  • red color
    setPageBackgroundColor("FF0000")
  • green color
    setPageBackgroundColor("00ff00")
  • green color with 50% opacity
    setPageBackgroundColor("00ff0080") 
def setDpi(dpi)
Set the DPI resolution of the input image. The DPI affects margin options specified in points too (e.g. 1 point is equal to 1 pixel in 96 DPI).
dpi
The DPI value.
Default: 96
Example:
  • The DPI used for printers. 1 inch contains 300 points.
    setDpi(300)

Watermark & Background

def setPageWatermark(watermark)
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.
watermark
The file path to a local file.
The file must exist and not be empty.
Examples:
  • setPageWatermark("/home/user/john/watermark.pdf")
  • setPageWatermark("/home/user/john/watermark.png") 
def setPageWatermarkUrl(url)
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.
url
Supported protocols are http:// and https://.
Examples:
  • setPageWatermarkUrl("http://myserver.com/watermark.pdf")
  • setPageWatermarkUrl("http://myserver.com/watermark.png") 
def setMultipageWatermark(watermark)
Apply each page of a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.
watermark
The file path to a local file.
The file must exist and not be empty.
Examples:
  • setMultipageWatermark("/home/user/john/watermark.pdf")
  • setMultipageWatermark("/home/user/john/watermark.png") 
def setMultipageWatermarkUrl(url)
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.
url
Supported protocols are http:// and https://.
Examples:
  • setMultipageWatermarkUrl("http://myserver.com/watermark.pdf")
  • setMultipageWatermarkUrl("http://myserver.com/watermark.png") 
def setPageBackground(background)
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.
background
The file path to a local file.
The file must exist and not be empty.
Examples:
  • setPageBackground("/home/user/john/background.pdf")
  • setPageBackground("/home/user/john/background.png") 
def setPageBackgroundUrl(url)
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.
url
Supported protocols are http:// and https://.
Examples:
  • setPageBackgroundUrl("http://myserver.com/background.pdf")
  • setPageBackgroundUrl("http://myserver.com/background.png") 
def setMultipageBackground(background)
Apply each page of a background to the corresponding page of the output PDF. A background can be either a PDF or an image.
background
The file path to a local file.
The file must exist and not be empty.
Examples:
  • setMultipageBackground("/home/user/john/background.pdf")
  • setMultipageBackground("/home/user/john/background.png") 
def setMultipageBackgroundUrl(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.
url
Supported protocols are http:// and https://.
Examples:
  • setMultipageBackgroundUrl("http://myserver.com/background.pdf")
  • setMultipageBackgroundUrl("http://myserver.com/background.png")

PDF Format

Miscellaneous values for PDF output.

def setLinearize(value)
Create linearized PDF. This is also known as Fast Web View.
value
Set to true to create linearized PDF.
Default: false 
def setEncrypt(value)
Encrypt the PDF. This prevents search engines from indexing the contents.
value
Set to true to enable PDF encryption.
Default: false 
def setUserPassword(password)
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.
password
The user password.
Example:
  • setUserPassword("123456") 
def setOwnerPassword(password)
Protect the PDF with an owner password. Supplying an owner password grants unlimited access to the PDF including changing the passwords and access permissions.
password
The owner password.
Example:
  • setOwnerPassword("123456") 
def setNoPrint(value)
Disallow printing of the output PDF.
value
Set to true to set the no-print flag in the output PDF.
Default: false 
def setNoModify(value)
Disallow modification of the output PDF.
value
Set to true to set the read-only only flag in the output PDF.
Default: false 
def setNoCopy(value)
Disallow text and graphics extraction from the output PDF.
value
Set to true to set the no-copy flag in the output PDF.
Default: false 
def setTitle(title)
Set the title of the PDF.
title
The title.
Example:
  • setTitle("My Resume") 
def setSubject(subject)
Set the subject of the PDF.
subject
The subject.
Example:
  • setSubject("CV - Software Developer") 
def setAuthor(author)
Set the author of the PDF.
author
The author.
Example:
  • setAuthor("John Doe") 
def setKeywords(keywords)
Associate keywords with the document.
keywords
The string with the keywords.
Example:
  • setKeywords("software developer, Unix, databases")

Viewer Preferences

These preferences specify how a PDF viewer should present the document. The preferences may be ignored by some PDF viewers.

def setPageLayout(layout)
Specify the page layout to be used when the document is opened.
layout
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. 
def setPageMode(mode)
Specify how the document should be displayed when opened.
mode
Allowed values:
  • full-screen
    Full-screen mode.
  • thumbnails
    Thumbnail images are visible.
  • outlines
    Document outline is visible. 
def setInitialZoomType(zoom_type)
Specify how the page should be displayed when opened.
zoom_type
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. 
def setInitialPage(page)
Display the specified page when the document is opened.
page
Must be a positive integer.
Example:
  • setInitialPage(2) 
def setInitialZoom(zoom)
Specify the initial page zoom in percents when the document is opened.
zoom
Must be a positive integer.
Example:
  • setInitialZoom(50) 
def setHideToolbar(value)
Specify whether to hide the viewer application's tool bars when the document is active.
value
Set to true to hide tool bars.
Default: false 
def setHideMenubar(value)
Specify whether to hide the viewer application's menu bar when the document is active.
value
Set to true to hide the menu bar.
Default: false 
def setHideWindowUi(value)
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.
value
Set to true to hide ui elements.
Default: false 
def setFitWindow(value)
Specify whether to resize the document's window to fit the size of the first displayed page.
value
Set to true to resize the window.
Default: false 
def setCenterWindow(value)
Specify whether to position the document's window in the center of the screen.
value
Set to true to center the window.
Default: false 
def setDisplayTitle(value)
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.
value
Set to true to display the title.
Default: false

Miscellaneous

def setDebugLog(value)
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.
value
Set to true to enable the debug logging.
Default: false 
def getDebugLogUrl()
Get the URL of the debug log for the last conversion.
Returns
  • string - The link to the debug log. 
def getRemainingCreditCount()
Get the number of conversion credits available in your account.
This method can only be called after a call to one of the convertXtoY 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.
Returns
  • int - The number of credits. 
def getConsumedCreditCount()
Get the number of credits consumed by the last conversion.
Returns
  • int - The number of credits. 
def getJobId()
Get the job id.
Returns
  • string - The unique job identifier. 
def getOutputSize()
Get the size of the output in bytes.
Returns
  • int - The count of bytes. 
def getVersion()
Get the version details.
Returns
  • string - API version, converter version, and client version. 
def setTag(tag)
Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
tag
A string with the custom tag.
Example:
  • setTag("client-1234") 
def setHttpProxy(proxy)
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.
proxy
The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
  • setHttpProxy("myproxy.com:8080")
  • setHttpProxy("113.25.84.10:33333") 
def setHttpsProxy(proxy)
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.
proxy
The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
  • setHttpsProxy("myproxy.com:443")
  • setHttpsProxy("113.25.84.10:44333")

API Client Options

def setConverterVersion(version)
Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.
Availability: API client >= 5.0.0. See versioning.
version
The version identifier.
Allowed values:
  • 24.04
    Version 24.04.
  • 20.10
    Version 20.10.
  • 18.10
    Version 18.10.
Default: 24.04 
def setUseHttp(value)
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
value
Set to true to use HTTP.
Default: false

Warning

Using HTTP is insecure as data sent over HTTP is not encrypted. Enable this option only if you know what you are doing.

def setClientUserAgent(agent)
Specifies the User-Agent HTTP header that the client library will use when interacting with the API.
Availability: API client >= 6.4.0 See versioning.
agent
The user agent string. 
def setUserAgent(agent)
Deprecated Replaced with: setClientUserAgent()
Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
agent
The user agent string.
Default: pdfcrowd_ruby_client/6.5.0 (https://pdfcrowd.com) 
def setProxy(host, port, user_name, password)
Specifies an HTTP proxy that the API client library will use to connect to the internet.
host
The proxy hostname.
port
The proxy port.
user_name
The username.
password
The password. 
def setRetryCount(count)
Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0.
count
Number of retries.
Default: 1
Example:
  • setRetryCount(3)