Image output

Convert highcharts.js into an image

Generate charts and graphs using Highcharts.js

You can generate images of charts using Highcharts.js + the HTML/CSS to Image API. When making charts, be sure to disable any animations. They may cause issues when creating the image.

Interactive example

Edit and render this image

This example depends on browser behavior that cannot run reliably in the inline iframe. Edit the source and options, then select regenerate image to preview the real API output.

Content

Adjust how content is rendered by adjusting these settings.

Url ?

Pass a publicly available URL and the API will screenshot it. This overrides any HTML. (Only applies when a URL is provided)

Google Fonts ?

Google fonts to be loaded. Example: Roboto. Multiple fonts can be loaded like this: Roboto|Open Sans. You must also set the font-family in your CSS to use the loaded font.

Selector ?

A CSS selector for an element in the HTML. We’ll crop the image to this specific element.

Transparent Background ?

Remove the background of the rendered image.

Image size & Viewport

By default images are cropped to the outermost HTML element or the chosen selector. Adjust viewport and sizing settings below.

Full Screen ?

Take a screenshot of the entire screen (Only applies when a URL is provided)

Device Scale ?

Adjusts the pixel ratio for the screenshot. The default is 2 which is equivalent to a 4K monitor.

Viewport ?

Height

Width

Set the height and width of Chrome's viewport. Setting a viewport disables automatic cropping.

Landscape Viewport

Set the viewport to landscape orientation.

Mobile Viewport

Instructs the viewport to behave as if it's being viewed from a mobile device.

Touch Viewport

Instructs the viewport to behave as if it is being viewed on a device supporting touch events.

Timing

By default the API generates a screenshot once everything is loaded. If the page executes JavaScript, you may want extra time before the image is rendered.

Ms Delay ?

Adds extra time for JavaScript to execute. Use this if you're seeing a blank image and are using JavaScript.
Default: 0. Start with 500 if needed.

Max Wait Ms ?

Sets a limit on time to wait until the screenshot is taken. Use this if your page loads a lot of extra irrelevant content, and you want to reduce the render time.

Render When Ready? ?

Check to control when the image is generated.
Call ScreenshotReady() from JavaScript in your code to trigger the image generation.

Browser Context

These settings will impact how Chrome is started, giving you more control when taking screenshots.

Color Scheme ?

Set Chrome to render assuming the user has explicitly set their browser to Light or Dark mode.

Media Type

Set Chrome to render as if it's being set to print or screen mode.

Timezone ?

Render your image with Chrome set to a specified timezone.

Block Consent Banners ?

Attempt to block cookie/consent banners from displaying (Only applies when a URL is provided)

Identify as HCTI

Send X-HCTI-SCREENSHOT: 1 with the top-level page navigation (Only applies when a URL is provided)

Current output for Convert highcharts.js into an image

Example code

Use this request in your app

Choose a language and copy a complete request using this example's HTML, CSS, and API options.

// dotnet add package HtmlCssToImage

using HtmlCssToImage;
using HtmlCssToImage.Models;
using HtmlCssToImage.Models.Requests;
using System.Collections.Generic;
using System.Text.Json.Nodes;

// In an application, use IHttpClientFactory through dependency injection:
// https://www.nuget.org/packages/HtmlCssToImage.DependencyInjection
using var httpClient = new HttpClient();
var client = new HtmlCssToImageClient(
    httpClient,
    new HtmlCssToImageOptions(
        Environment.GetEnvironmentVariable("HCTI_API_ID")!,
        Environment.GetEnvironmentVariable("HCTI_API_KEY")!));

var request = new CreateHtmlCssImageRequest
{
    Html = """
           <script src="https://code.highcharts.com/highcharts.js"></script>
           <script src="https://code.highcharts.com/modules/series-label.js"></script>
           
           <div id="container"></div>
           
           <script>  
           Highcharts.chart('container', {
             chart: {
               animation: false
             },
             title: {
               text: 'Solar Employment Growth by Sector, 2010-2016'
             },
           
             subtitle: {
               text: 'Source: thesolarfoundation.com'
             },
           
             yAxis: {
           
               title: {
                 text: 'Number of Employees'
               }
             },
             legend: {
               layout: 'vertical',
               align: 'right',
               verticalAlign: 'middle'
             },
           
             plotOptions: {
               series: {
                 animation: false,
                 label: {
                   connectorAllowed: false
                 },
                 pointStart: 2010
               }
             },
           
             series: [{
               name: 'Installation',
               data: [43934, 52503, 57177, 69658, 97031, 119931, 137133, 154175]
             }, {
               name: 'Manufacturing',
               data: [24916, 24064, 29742, 29851, 32490, 30282, 38121, 40434]
             }, {
               name: 'Sales & Distribution',
               data: [11744, 17722, 16005, 19771, 20185, 24377, 32147, 39387]
             }, {
               name: 'Project Development',
               data: [null, null, 7988, 12169, 15112, 22452, 34400, 34227]
             }, {
               name: 'Other',
               data: [12908, 5948, 8105, 11248, 8989, 11816, 18274, 18111]
             }],
           
             responsive: {
               rules: [{
                 condition: {
                   maxWidth: 500
                 },
                 chartOptions: {
                   legend: {
                     layout: 'horizontal',
                     align: 'center',
                     verticalAlign: 'bottom'
                   }
                 }
               }]
             }
           });
           </script>
           """,
    MsDelay = 200,
    TransparentBackground = true,
};

using var result = await client.CreateImageAsync(request);
if (result.Success && result.Response is not null)
{
    Console.WriteLine(result.Response.Url);
}

Read the C# Docs NuGet package

Request configuration

Options used in this example

These values are sent with the HTML and CSS to control how HCTI loads the page and captures the final screenshot. You can change each one in the editor above.

Transparent Background

transparent_background

True

If set to true, the background of the rendered image will be transparent.

Learn about this option

Ms Delay

ms_delay

200

Adds extra time before taking the screenshot, like if you need to wait for Javascript to execute

Learn about this option

From code to screenshot

How HCTI examples work

HTML/CSS to Image renders HTML and CSS in hosted Chrome, then captures the result as an image or PDF. Each example combines real source code with the API options used for the render, so it is both a working demo and a starting point for your own request.

Edit the source and options above to test changes in the browser, then render through the API to see the production result.

Common questions

Can I use the HTML and CSS from these examples?

Yes. Open an example to inspect and edit its complete HTML, CSS, and render options. Use it as a starting point, then send the resulting request from your application.

What is the difference between an example and a template?

Examples are complete API requests built from HTML and CSS. Templates are saved, reusable designs created in the visual editor and rendered repeatedly with different variable values.

Does HCTI create screenshots and PDFs?

Yes. HCTI can render HTML and CSS or capture a public webpage as an image, and it can generate PDFs when you need document output instead of a screenshot.