HTML to Image in Ruby

Overview

This page serves as a guide for using the PDFCrowd API to capture web pages and HTML content to image screenshots in Ruby applications.

Installation

You can install the client library from rubygems.org

gem install pdfcrowd

Download pdfcrowd-6.5.0.gem.
Extract the archive and run the following commands:
```
gem install pdfcrowd-6.5.0.gem
```

Clone pdfcrowd-ruby from Github and install the library:

git clone https://github.com/pdfcrowd/pdfcrowd-ruby
cd pdfcrowd-ruby
make dist
gem install pdfcrowd-6.5.0.gem

Quick Start

Below are Ruby examples to help you quickly get started with the API. Explore our additional examples for more insights.

require "pdfcrowd"

begin
    # Create an API client instance.
    client = Pdfcrowd::HtmlToImageClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

    # Configure the conversion.
    client.setOutputFormat("png")

    # Run the conversion and save the result to a file.
    client.convertUrlToFile("http://www.example.com", "example.png")

rescue Pdfcrowd::Error => why
    STDERR.puts "PDFCrowd Error: #{why}"
    raise
end

require "pdfcrowd"

begin
    # Create an API client instance.
    client = Pdfcrowd::HtmlToImageClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

    # Configure the conversion.
    client.setOutputFormat("png")

    # Run the conversion and save the result to a file.
    client.convertFileToFile("/path/to/MyLayout.html", "MyLayout.png")

rescue Pdfcrowd::Error => why
    STDERR.puts "PDFCrowd Error: #{why}"
    raise
end

require "pdfcrowd"

begin
    # Create an API client instance.
    client = Pdfcrowd::HtmlToImageClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

    # Configure the conversion.
    client.setOutputFormat("png")

    # Run the conversion and save the result to a file.
    client.convertStringToFile("<html><body><h1>Hello World!</h1></body></html>", "HelloWorld.png")

rescue Pdfcrowd::Error => why
    STDERR.puts "PDFCrowd Error: #{why}"
    raise
end

Authentication

To access the API, you will need to use your PDFCrowd username and API key. For initial testing, you may use the following demo credentials without registering:

Username: demo
API key: ce544b6ea52a5621fb9d55f8b542d14d

To obtain your personal API credentials, start a free trial or purchase the API license.

Customization

The table below highlights the most common customizations you might find useful. Refer to the Option Reference for a detailed description of all available options. For an interactive experience, explore these options in the API Playground.

For additional customization options and Troubleshooting, please visit the FAQ section of our website where you can find answers and help related to frequent queries and common issues.

Image size	Customize the dimensions of the captured images using the setScreenshotWidth() and setScreenshotHeight().
Image format	Change the ouput image format using setOutputFormat().
Hide or Remove Contents	Use the following classes in your HTML code to hide or remove elements from the output: `pdfcrowd-remove`: This class applies `display:none!important` to the element, effectively removing it from the layout. `pdfcrowd-hide`: This class applies `visibility:hidden!important` to the element, making it invisible but still occupying space in the layout. For additional methods and detailed explanation, refer to this FAQ article.
Custom CSS Styling	To customize CSS styling specifically for the conversion, use setCustomCss() to inject additional styles. Alternatively, you can directly incorporate conversion-specific styling into your main stylesheet. Just prefix your CSS selectors with `.pdfcrowd-body` to ensure the styles apply only during the conversion process. For example: `.pdfcrowd-body h1 { font-size: 48px; }` `.pdfcrowd-body footer { display: none; }`
Use `@media print`	Activate the print version of a webpage (if available) using setUsePrintMedia(). This function instructs the API to apply the CSS rules defined within the `@media print` stylesheet, ensuring the output mirrors the print-optimized version of the webpage.
Inject Custom JavaScript	Use setCustomJavascript() or setOnLoadJavascript() to modify HTML content using custom JavaScript scripts. These scripts run when the page loads, allowing you to dynamically alter elements, styles, or behavior. In addition to the standard browser JavaScript APIs, your scripts can leverage helper functions provided by our JavaScript library.
HTML Templates	Add data to your HTML templates for dynamic generation tailored to specific content needs. For details, refer to HTML Template to Image.

Error Handling

It is recommended that you implement error handling to catch errors the API may return. Effective error handling is vital as it ensures application stability and provides clearer diagnostics. See the example code below for guidance on implementing error handling, and refer to this list of status codes for more information.

begin 
    # Call the API 
rescue Pdfcrowd::Error => why 
    # Log the complete error
    STDERR.puts "PDFCrowd Error: #{why}"

    # Log the HTTP status code
    STDERR.puts "Status Code: #{why.getStatusCode()}"

    # Log the reason code
    STDERR.puts "Reason Code: #{why.getReasonCode()}"

    # Log the error message
    STDERR.puts "Error Message: #{why.getMessage()}"

    # Log the documentation link
    STDERR.puts "Documentation Link: #{why.getDocumentationLink()}"
end

Troubleshooting

If you are receiving an error, refer to the API Status Codes for more information.
Use setDebugLog() and getDebugLogUrl() to obtain detailed information about the conversion process, including load errors, load times, browser console output, etc.
Consult the FAQ for answers to common questions.
The maximum size for any created image is 65 megapixels. Images exceeding this size are cropped vertically to meet this limit.
Contact us if you need assistance or if there is a feature you are missing.

API Method Reference

Refer to the HTML to Image Ruby Reference for a description of all API methods.

HTML to Image / Ruby Guide