HTML to Image Java Examples

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

Basic examples
Template rendering examples
Spring examples

Basic examples

Webpage to PNG file

import com.pdfcrowd.*;
import java.io.*;

public class ApiTest {
    public static void main(String[] args) throws IOException, Pdfcrowd.Error {
        try {
            // create the API client instance
            Pdfcrowd.HtmlToImageClient client =
                new Pdfcrowd.HtmlToImageClient("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");
        }
        catch(Pdfcrowd.Error why) {
            System.err.println("Pdfcrowd Error: " + why);
            throw why;
        }
        catch(IOException why) {
            System.err.println("IO Error: " + why);
            throw why;
        }
    }
}

Webpage to in-memory PNG

import com.pdfcrowd.*;
import java.io.*;

public class ApiTest {
    public static void main(String[] args) throws Pdfcrowd.Error {
        try {
            // create the API client instance
            Pdfcrowd.HtmlToImageClient client =
                new Pdfcrowd.HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setOutputFormat("png");

            // run the conversion and store the result into the "image" variable
            byte[] 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.
        }
        catch(Pdfcrowd.Error why) {
            System.err.println("Pdfcrowd Error: " + why);
            throw why;
        }
    }
}

Webpage to PNG stream

import com.pdfcrowd.*;
import java.io.*;

public class ApiTest {
    public static void main(String[] args) throws IOException, Pdfcrowd.Error {
        try {
            // create the API client instance
            Pdfcrowd.HtmlToImageClient client =
                new Pdfcrowd.HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setOutputFormat("png");

            // create an output stream for the conversion result
            FileOutputStream outputStream = new FileOutputStream("example.png");

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

            // close the output stream
            outputStream.close();
        }
        catch(Pdfcrowd.Error why) {
            System.err.println("Pdfcrowd Error: " + why);
            throw why;
        }
        catch(IOException why) {
            System.err.println("IO Error: " + why);
            throw why;
        }
    }
}

HTML file to PNG file

import com.pdfcrowd.*;
import java.io.*;

public class ApiTest {
    public static void main(String[] args) throws IOException, Pdfcrowd.Error {
        try {
            // create the API client instance
            Pdfcrowd.HtmlToImageClient client =
                new Pdfcrowd.HtmlToImageClient("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");
        }
        catch(Pdfcrowd.Error why) {
            System.err.println("Pdfcrowd Error: " + why);
            throw why;
        }
        catch(IOException why) {
            System.err.println("IO Error: " + why);
            throw why;
        }
    }
}

HTML file to in-memory PNG

import com.pdfcrowd.*;
import java.io.*;

public class ApiTest {
    public static void main(String[] args) throws Pdfcrowd.Error {
        try {
            // create the API client instance
            Pdfcrowd.HtmlToImageClient client =
                new Pdfcrowd.HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setOutputFormat("png");

            // run the conversion and store the result into the "image" variable
            byte[] 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.
        }
        catch(Pdfcrowd.Error why) {
            System.err.println("Pdfcrowd Error: " + why);
            throw why;
        }
    }
}

HTML file to PNG stream

import com.pdfcrowd.*;
import java.io.*;

public class ApiTest {
    public static void main(String[] args) throws IOException, Pdfcrowd.Error {
        try {
            // create the API client instance
            Pdfcrowd.HtmlToImageClient client =
                new Pdfcrowd.HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setOutputFormat("png");

            // create an output stream for the conversion result
            FileOutputStream outputStream = new FileOutputStream("MyLayout.png");

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

            // close the output stream
            outputStream.close();
        }
        catch(Pdfcrowd.Error why) {
            System.err.println("Pdfcrowd Error: " + why);
            throw why;
        }
        catch(IOException why) {
            System.err.println("IO Error: " + why);
            throw why;
        }
    }
}

HTML string to PNG file

import com.pdfcrowd.*;
import java.io.*;

public class ApiTest {
    public static void main(String[] args) throws IOException, Pdfcrowd.Error {
        try {
            // create the API client instance
            Pdfcrowd.HtmlToImageClient client =
                new Pdfcrowd.HtmlToImageClient("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");
        }
        catch(Pdfcrowd.Error why) {
            System.err.println("Pdfcrowd Error: " + why);
            throw why;
        }
        catch(IOException why) {
            System.err.println("IO Error: " + why);
            throw why;
        }
    }
}

HTML string to in-memory PNG

import com.pdfcrowd.*;
import java.io.*;

public class ApiTest {
    public static void main(String[] args) throws Pdfcrowd.Error {
        try {
            // create the API client instance
            Pdfcrowd.HtmlToImageClient client =
                new Pdfcrowd.HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setOutputFormat("png");

            // run the conversion and store the result into the "image" variable
            byte[] 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.
        }
        catch(Pdfcrowd.Error why) {
            System.err.println("Pdfcrowd Error: " + why);
            throw why;
        }
    }
}

HTML string to PNG stream

import com.pdfcrowd.*;
import java.io.*;

public class ApiTest {
    public static void main(String[] args) throws IOException, Pdfcrowd.Error {
        try {
            // create the API client instance
            Pdfcrowd.HtmlToImageClient client =
                new Pdfcrowd.HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setOutputFormat("png");

            // create an output stream for the conversion result
            FileOutputStream outputStream = new FileOutputStream("HelloWorld.png");

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

            // close the output stream
            outputStream.close();
        }
        catch(Pdfcrowd.Error why) {
            System.err.println("Pdfcrowd Error: " + why);
            throw why;
        }
        catch(IOException why) {
            System.err.println("IO Error: " + why);
            throw why;
        }
    }
}

Get info about the current conversion

import com.pdfcrowd.*;
import java.io.*;

public class ApiTest {
    public static void main(String[] args) throws IOException, Pdfcrowd.Error {
        try {
            // create the API client instance
            Pdfcrowd.HtmlToImageClient client =
                new Pdfcrowd.HtmlToImageClient("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 of the debug log
            System.out.println("Debug log url: " + client.getDebugLogUrl());
            
            // print the number of conversion credits remaining in your account
            System.out.println("Remaining credit count: " + client.getRemainingCreditCount());
            
            // print the number of credits used for the conversion
            System.out.println("Consumed credit count: " + client.getConsumedCreditCount());
            
            // print the unique identifier for the conversion
            System.out.println("Job id: " + client.getJobId());
            
            // print size of the output data in bytes
            System.out.println("Output size: " + client.getOutputSize());
        }
        catch(Pdfcrowd.Error why) {
            System.err.println("Pdfcrowd Error: " + why);
            throw why;
        }
        catch(IOException why) {
            System.err.println("IO Error: " + why);
            throw why;
        }
    }
}

Template rendering examples

Create Image from JSON data

import com.pdfcrowd.*;
import java.io.*;

public class ApiTest {
    public static void main(String[] args) throws IOException, Pdfcrowd.Error {
        try {
            // create the API client instance
            Pdfcrowd.HtmlToImageClient client =
                new Pdfcrowd.HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setOutputFormat("png");
            client.setDataString("{\n" +
                "    \"name\": \"World\",\n" +
                "    \"product\": \"Pdfcrowd API\"\n" +
                "}");

            // run the conversion and write the result to a file
            client.convertStringToFile("Hello {{ name }} from {{ product }}", "output.pdf");
        }
        catch(Pdfcrowd.Error why) {
            System.err.println("Pdfcrowd Error: " + why);
            throw why;
        }
        catch(IOException why) {
            System.err.println("IO Error: " + why);
            throw why;
        }
    }
}

Create Image from XML data

import com.pdfcrowd.*;
import java.io.*;

public class ApiTest {
    public static void main(String[] args) throws IOException, Pdfcrowd.Error {
        try {
            // create the API client instance
            Pdfcrowd.HtmlToImageClient client =
                new Pdfcrowd.HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setOutputFormat("png");
            client.setDataString("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" +
                "<data>\n" +
                "  <name>World</name>\n" +
                "  <product>Pdfcrowd API</product>\n" +
                "</data>");

            // run the conversion and write the result to a file
            client.convertStringToFile("Hello {{ data.name }} from {{ data.product }}", "output.pdf");
        }
        catch(Pdfcrowd.Error why) {
            System.err.println("Pdfcrowd Error: " + why);
            throw why;
        }
        catch(IOException why) {
            System.err.println("IO Error: " + why);
            throw why;
        }
    }
}

Create Image from YAML data

import com.pdfcrowd.*;
import java.io.*;

public class ApiTest {
    public static void main(String[] args) throws IOException, Pdfcrowd.Error {
        try {
            // create the API client instance
            Pdfcrowd.HtmlToImageClient client =
                new Pdfcrowd.HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setOutputFormat("png");
            client.setDataString("name: World\n" +
                "product: Pdfcrowd API");

            // run the conversion and write the result to a file
            client.convertStringToFile("Hello {{ name }} from {{ product }}", "output.pdf");
        }
        catch(Pdfcrowd.Error why) {
            System.err.println("Pdfcrowd Error: " + why);
            throw why;
        }
        catch(IOException why) {
            System.err.println("IO Error: " + why);
            throw why;
        }
    }
}

Create Image from CSV data

import com.pdfcrowd.*;
import java.io.*;

public class ApiTest {
    public static void main(String[] args) throws IOException, Pdfcrowd.Error {
        try {
            // create the API client instance
            Pdfcrowd.HtmlToImageClient client =
                new Pdfcrowd.HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setOutputFormat("png");
            client.setDataString("name,product\n" +
                "World,Pdfcrowd API");

            // run the conversion and write the result to a file
            client.convertStringToFile("Hello {{ name }} from {{ product }}", "output.pdf");
        }
        catch(Pdfcrowd.Error why) {
            System.err.println("Pdfcrowd Error: " + why);
            throw why;
        }
        catch(IOException why) {
            System.err.println("IO Error: " + why);
            throw why;
        }
    }
}

Spring examples

Webpage to PNG in Spring

import java.net.URLEncoder;
import java.io.UnsupportedEncodingException;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.http.ResponseEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import com.pdfcrowd.*;

@Controller
public class DemoController {
    // the recommended method is POST
    @PostMapping("/")
    public ResponseEntity<byte[]> convert() throws UnsupportedEncodingException {
        try {
            // create the API client instance
            Pdfcrowd.HtmlToImageClient client =
                new Pdfcrowd.HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setOutputFormat("png");

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

            // set HTTP response headers
            HttpHeaders headers = new HttpHeaders();
            headers.add("Content-Type", "image/png");
            headers.add("Cache-Control", "max-age=0");
            headers.add("Accept-Ranges", "none");
            headers.add("Content-Disposition", "attachment; filename*=UTF-8''" +
                        URLEncoder.encode("example.png", "UTF-8").replace("+", "%20"));

            // send the result in the HTTP response
            return new ResponseEntity<>(image, headers, HttpStatus.OK);
        }
        catch(Pdfcrowd.Error why) {
            // send the error in the HTTP response
            HttpHeaders headers = new HttpHeaders();
            headers.add("Content-Type", "text/plain");
            String msg = String.format("Pdfcrowd Error: %d - %s",
                                       why.getCode(), why.getMessage());
            return new ResponseEntity<>(msg.getBytes(), headers, HttpStatus.BAD_REQUEST);
        }
    }
}

HTML file to PNG in Spring

import java.net.URLEncoder;
import java.io.UnsupportedEncodingException;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.http.ResponseEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import com.pdfcrowd.*;

@Controller
public class DemoController {
    // the recommended method is POST
    @PostMapping("/")
    public ResponseEntity<byte[]> convert() throws UnsupportedEncodingException {
        try {
            // create the API client instance
            Pdfcrowd.HtmlToImageClient client =
                new Pdfcrowd.HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setOutputFormat("png");

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

            // set HTTP response headers
            HttpHeaders headers = new HttpHeaders();
            headers.add("Content-Type", "image/png");
            headers.add("Cache-Control", "max-age=0");
            headers.add("Accept-Ranges", "none");
            headers.add("Content-Disposition", "attachment; filename*=UTF-8''" +
                        URLEncoder.encode("MyLayout.png", "UTF-8").replace("+", "%20"));

            // send the result in the HTTP response
            return new ResponseEntity<>(image, headers, HttpStatus.OK);
        }
        catch(Pdfcrowd.Error why) {
            // send the error in the HTTP response
            HttpHeaders headers = new HttpHeaders();
            headers.add("Content-Type", "text/plain");
            String msg = String.format("Pdfcrowd Error: %d - %s",
                                       why.getCode(), why.getMessage());
            return new ResponseEntity<>(msg.getBytes(), headers, HttpStatus.BAD_REQUEST);
        }
    }
}

HTML string to PNG in Spring

import java.net.URLEncoder;
import java.io.UnsupportedEncodingException;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.http.ResponseEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import com.pdfcrowd.*;

@Controller
public class DemoController {
    // the recommended method is POST
    @PostMapping("/")
    public ResponseEntity<byte[]> convert() throws UnsupportedEncodingException {
        try {
            // create the API client instance
            Pdfcrowd.HtmlToImageClient client =
                new Pdfcrowd.HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setOutputFormat("png");

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

            // set HTTP response headers
            HttpHeaders headers = new HttpHeaders();
            headers.add("Content-Type", "image/png");
            headers.add("Cache-Control", "max-age=0");
            headers.add("Accept-Ranges", "none");
            headers.add("Content-Disposition", "attachment; filename*=UTF-8''" +
                        URLEncoder.encode("HelloWorld.png", "UTF-8").replace("+", "%20"));

            // send the result in the HTTP response
            return new ResponseEntity<>(image, headers, HttpStatus.OK);
        }
        catch(Pdfcrowd.Error why) {
            // send the error in the HTTP response
            HttpHeaders headers = new HttpHeaders();
            headers.add("Content-Type", "text/plain");
            String msg = String.format("Pdfcrowd Error: %d - %s",
                                       why.getCode(), why.getMessage());
            return new ResponseEntity<>(msg.getBytes(), headers, HttpStatus.BAD_REQUEST);
        }
    }
}