HTML to Image Ruby Examples

This page contains various examples of using the HTML to Image API in Ruby. The examples are complete and fully functional. Read more about how to convert HTML to Image in Ruby.

Basic examples
Template rendering examples

Basic examples

Convert a web page to a PNG file

require "pdfcrowd"

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

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

    # run the conversion and write the result to a file
    client.convertUrlToFile("http://www.example.com", "example.png")
rescue Pdfcrowd::Error => why
    # report the error
    STDERR.puts "Pdfcrowd Error: #{why}"

    # rethrow or handle the exception
    raise
end

Convert a web page to in-memory PNG

require "pdfcrowd"

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

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

    # run the conversion and store the result into the "image" variable
    image = client.convertUrl("http://www.example.com")

    # at this point the "image" variable contains PNG raw data and
    # can be sent in an HTTP response, saved to a file, etc.
rescue Pdfcrowd::Error => why
    # report the error
    STDERR.puts "Pdfcrowd Error: #{why}"

    # rethrow or handle the exception
    raise
end

Convert a web page and write the resulting PNG to an output stream

require "pdfcrowd"

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

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

    # create an output stream for the conversion result
    output_stream = open("example.png", "wb")

    # run the conversion and write the result into the output stream
    client.convertUrlToStream("http://www.example.com", output_stream)

    # close the output stream
    output_stream.close()
rescue Pdfcrowd::Error => why
    # report the error
    STDERR.puts "Pdfcrowd Error: #{why}"

    # rethrow or handle the exception
    raise
end

Convert a local HTML file to a PNG file

require "pdfcrowd"

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

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

    # run the conversion and write the result to a file
    client.convertFileToFile("/path/to/MyLayout.html", "MyLayout.png")
rescue Pdfcrowd::Error => why
    # report the error
    STDERR.puts "Pdfcrowd Error: #{why}"

    # rethrow or handle the exception
    raise
end

Convert a local HTML file to in-memory PNG

require "pdfcrowd"

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

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

    # run the conversion and store the result into the "image" variable
    image = client.convertFile("/path/to/MyLayout.html")

    # at this point the "image" variable contains PNG raw data and
    # can be sent in an HTTP response, saved to a file, etc.
rescue Pdfcrowd::Error => why
    # report the error
    STDERR.puts "Pdfcrowd Error: #{why}"

    # rethrow or handle the exception
    raise
end

Convert a local HTML file and write the resulting PNG to an output stream

require "pdfcrowd"

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

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

    # create an output stream for the conversion result
    output_stream = open("MyLayout.png", "wb")

    # run the conversion and write the result into the output stream
    client.convertFileToStream("/path/to/MyLayout.html", output_stream)

    # close the output stream
    output_stream.close()
rescue Pdfcrowd::Error => why
    # report the error
    STDERR.puts "Pdfcrowd Error: #{why}"

    # rethrow or handle the exception
    raise
end

Convert a string containing HTML to a PNG file

require "pdfcrowd"

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

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

    # run the conversion and write the result to a file
    client.convertStringToFile("<html><body><h1>Hello World!</h1></body></html>", "HelloWorld.png")
rescue Pdfcrowd::Error => why
    # report the error
    STDERR.puts "Pdfcrowd Error: #{why}"

    # rethrow or handle the exception
    raise
end

Convert a string containing HTML to in-memory PNG

require "pdfcrowd"

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

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

    # run the conversion and store the result into the "image" variable
    image = client.convertString("<html><body><h1>Hello World!</h1></body></html>")

    # at this point the "image" variable contains PNG raw data and
    # can be sent in an HTTP response, saved to a file, etc.
rescue Pdfcrowd::Error => why
    # report the error
    STDERR.puts "Pdfcrowd Error: #{why}"

    # rethrow or handle the exception
    raise
end

Convert a string containing HTML and write the resulting PNG to an output stream

require "pdfcrowd"

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

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

    # create an output stream for the conversion result
    output_stream = open("HelloWorld.png", "wb")

    # run the conversion and write the result into the output stream
    client.convertStringToStream("<html><body><h1>Hello World!</h1></body></html>", output_stream)

    # close the output stream
    output_stream.close()
rescue Pdfcrowd::Error => why
    # report the error
    STDERR.puts "Pdfcrowd Error: #{why}"

    # rethrow or handle the exception
    raise
end

Get info about the current conversion

require "pdfcrowd"

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

    # configure the conversion
    client.setOutputFormat("png")
    client.setDebugLog(true)

    # run the conversion and write the result to a file
    client.convertFileToFile("/path/to/MyLayout.html", "MyLayout.png")
    
    # print URL to the debug log
    puts "Debug log url: #{client.getDebugLogUrl()}"
    
    # print the number of available conversion credits in your account
    puts "Remaining credit count: #{client.getRemainingCreditCount()}"
    
    # print the number of credits consumed by the conversion
    puts "Consumed credit count: #{client.getConsumedCreditCount()}"
    
    # print the unique ID of the conversion
    puts "Job id: #{client.getJobId()}"
    
    # print the size of the output in bytes
    puts "Output size: #{client.getOutputSize()}"
rescue Pdfcrowd::Error => why
    # report the error
    STDERR.puts "Pdfcrowd Error: #{why}"

    # rethrow or handle the exception
    raise
end

Advanced examples

Template rendering Examples

Create Image from JSON data

require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::HtmlToPdfClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

    # configure the conversion
    client.setDataString('{
            "name": "World",
            "product": "Pdfcrowd API"
        }')

    # run the conversion and write the result to a file
    client.convertStringToFile("Hello {{ name }} from {{ product }}", "output.pdf")
rescue Pdfcrowd::Error => why
    # report the error
    STDERR.puts "Pdfcrowd Error: #{why}"

    # rethrow or handle the exception
    raise
end

Create Image from XML data

require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::HtmlToPdfClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

    # configure the conversion
    client.setDataString('<?xml version="1.0" encoding="UTF-8"?>
        <data>
          <name>World</name>
          <product>Pdfcrowd API</product>
        </data>')

    # run the conversion and write the result to a file
    client.convertStringToFile("Hello {{ data.name }} from {{ data.product }}", "output.pdf")
rescue Pdfcrowd::Error => why
    # report the error
    STDERR.puts "Pdfcrowd Error: #{why}"

    # rethrow or handle the exception
    raise
end

Create Image from YAML data

require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::HtmlToPdfClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

    # configure the conversion
    client.setDataString("name: World
product: Pdfcrowd API")

    # run the conversion and write the result to a file
    client.convertStringToFile("Hello {{ name }} from {{ product }}", "output.pdf")
rescue Pdfcrowd::Error => why
    # report the error
    STDERR.puts "Pdfcrowd Error: #{why}"

    # rethrow or handle the exception
    raise
end

Create Image from CSV data

require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::HtmlToPdfClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

    # configure the conversion
    client.setDataString("name,product
World,Pdfcrowd API")

    # run the conversion and write the result to a file
    client.convertStringToFile("Hello {{ name }} from {{ product }}", "output.pdf")
rescue Pdfcrowd::Error => why
    # report the error
    STDERR.puts "Pdfcrowd Error: #{why}"

    # rethrow or handle the exception
    raise
end