Image watermark

Styling

An image watermark drawn behind the series.

tip

For more control than the built-in watermark gives, use the Image watermark plugin. It can anchor the image to a corner, fill the pane, or draw it behind one series instead of the whole pane. You can also replace the image after it is added.

Interactive example — scroll, zoom, and hover the chart.

Code

View on GitHub

// Lightweight Charts™ Example: Image Watermark
// https://tradingview.github.io/lightweight-charts/examples/styling/image-watermark

const chartOptions = {
    layout: {
        textColor: 'black',
        background: { type: 'solid', color: 'white' },
    },
    grid: {
        vertLines: { color: '#D6DCDE' },
        horzLines: { color: '#D6DCDE' },
    },
};
/** @type {import('lightweight-charts').IChartApi} */
const chart = createChart(document.getElementById('container'), chartOptions);

// imageDataUrl would usually be an url like '/images/my-image.png'
const imageDataUrl = 'data:image/svg+xml;base64,<svg xmlns="http://www.w3.org/2000/svg" width="292" height="128" viewBox="0 0 292 128"><path fill-rule="evenodd" d="m182.93 7.6.63-.37a64.1 64.1 0 0 0 2.43-5.31l4.77-1.39a64.68 64.68 0 0 1-4.72 10.54c.38 10.45-3.93 21.15-11.1 29.37-11.66 13.41-26.98 15.97-43.57 13.78l1.07-.98a21.1 21.1 0 0 0 3.72-4.05 48.37 48.37 0 0 1-11.04 2.84c-10.65-5.54-21.64-14.94-24.27-27.27 9.19-17 28.95-24.01 47.39-19.94a22.57 22.57 0 0 0 5.86 9.02c-.12-1.92-.1-3.84-.1-5.76l.01-1.78c4.8 2.96 9.66 5.85 15.52 5.7 4.08-.1 8.4-1.52 13.4-4.4Zm-22.55 23.28a8.48 8.48 0 0 0-12.45-.33l-7.9-7.26A8.6 8.6 0 0 0 132 12c-6.14 0-10.25 6.63-7.7 12.09l-13.02 12.19c-4.1-4.97-5.68-9.3-6.17-10.94 8.36-13.72 24.46-20.18 40.15-17.07 2.93 6.9 8.38 10.72 14.77 13.96l-.33-1.14c-.74-2.56-1.47-5.1-1.62-7.78 7.05 3.45 14.6 3.35 21.76.31-4.76 7.27-11.13 14.22-19.46 17.26Zm-22.56-4.19 8.03 7.38A8.6 8.6 0 0 0 154 45a8.6 8.6 0 0 0 8.25-10.55c7.99-3.08 14.37-9.38 19.28-16.23-3.47 19.47-21.96 34.61-41.9 32.98 1.77-2.84 2.49-6.06 3.21-9.28l.35-1.56c-5.47 3.77-10.67 6.38-17.37 7.52a49.9 49.9 0 0 1-11.85-8.65l12.83-12a8.58 8.58 0 0 0 11.02-.54ZM132 16a4.5 4.5 0 1 0 0 9 4.5 4.5 0 0 0 0-9Zm17.5 20.5a4.5 4.5 0 1 1 9 0 4.5 4.5 0 0 1-9 0ZM21.63 71.8a2.33 2.33 0 0 1 2.33 2.34 2.34 2.34 0 0 1-2.33 2.37 2.38 2.38 0 0 1-2.37-2.37 2.38 2.38 0 0 1 2.37-2.33Zm1.76 8.2v16h-3.52V80h3.52Zm-6.46 16H2.78V73.28h3.75v19.14h10.4V96Zm26.39-1.09V80H39.8v2.14a6.26 6.26 0 0 0-5.12-2.46c-4.32 0-7.68 3.58-7.68 8.1 0 4.54 3.36 8.12 7.68 8.12 2.2 0 4.16-1.08 5.12-2.5v1.48c0 3.23-2.18 5-4.83 5a7.03 7.03 0 0 1-5.32-2.34l-2.14 2.52c1.57 1.76 4.35 2.95 7.49 2.95 4.73 0 8.32-2.53 8.32-8.1Zm-12.77-7.13a4.7 4.7 0 0 1 4.77-4.9 4.7 4.7 0 0 1 4.77 4.9 4.7 4.7 0 0 1-4.77 4.9 4.7 4.7 0 0 1-4.77-4.9ZM51.58 96h-3.52V72h3.52v10.18c.96-1.6 2.78-2.5 4.86-2.5 3.71 0 6.11 2.62 6.11 6.69V96h-3.52v-9.06c0-2.52-1.28-4.06-3.33-4.06-2.33 0-4.12 1.82-4.12 5.25V96Zm24.86-.2v-3.13c-.52.2-1.22.32-1.9.32-1.82 0-2.68-.73-2.68-2.72v-7.13h4.58V80h-4.58v-4.45h-3.52V80h-3.33v3.14h3.33v7.7c0 3.62 2.4 5.32 5.47 5.32 1.09 0 1.92-.13 2.63-.35Zm20.3.2H93.4l-3.52-10.37L86.39 96h-3.32l-5.38-16h3.72l3.45 11 3.68-11h2.69l3.65 11 3.49-11h3.74l-5.38 16Zm6.76-8c0 4.86 3.49 8.32 8.35 8.32 3.36 0 5.86-1.44 7.3-3.71l-2.7-1.92a5.03 5.03 0 0 1-4.57 2.43c-2.65 0-4.77-1.73-4.93-4.35h12.58c.03-.51.03-.8.03-1.15 0-5.16-3.52-7.94-7.71-7.94A8.12 8.12 0 0 0 103.5 88Zm8.22-5.34c2.05 0 3.9 1.24 4.29 3.55h-8.9c.48-2.37 2.56-3.55 4.61-3.55Zm13.22-10.85a2.33 2.33 0 0 1 2.34 2.33 2.34 2.34 0 0 1-2.34 2.37 2.38 2.38 0 0 1-2.37-2.37 2.38 2.38 0 0 1 2.37-2.33Zm21.7 23.1V80h-3.53v2.14a6.26 6.26 0 0 0-5.12-2.46c-4.32 0-7.68 3.58-7.68 8.1 0 4.54 3.36 8.12 7.68 8.12 2.2 0 4.16-1.08 5.12-2.5v1.48c0 3.23-2.18 5-4.83 5a7.03 7.03 0 0 1-5.31-2.34l-2.15 2.52c1.57 1.76 4.36 2.95 7.5 2.95 4.73 0 8.31-2.53 8.31-8.1ZM126.7 96h-3.52V80h3.52v16Zm7.16-8.22a4.7 4.7 0 0 1 4.77-4.9 4.7 4.7 0 0 1 4.77 4.9 4.7 4.7 0 0 1-4.77 4.9 4.7 4.7 0 0 1-4.77-4.9ZM154.9 96h-3.52V72h3.52v10.18c.96-1.6 2.78-2.5 4.86-2.5 3.71 0 6.11 2.62 6.11 6.69V96h-3.52v-9.06c0-2.52-1.28-4.06-3.32-4.06-2.34 0-4.13 1.82-4.13 5.25V96Zm24.86-.2v-3.13c-.51.2-1.22.32-1.89.32-1.82 0-2.69-.73-2.69-2.72v-7.13h4.58V80h-4.58v-4.45h-3.52V80h-3.33v3.14h3.33v7.7c0 3.62 2.4 5.32 5.47 5.32 1.1 0 1.92-.13 2.63-.35Zm21.59.58a11.67 11.67 0 0 1-11.75-11.74c0-6.56 5.22-11.74 11.75-11.74 4.45 0 8.22 2.27 10.24 5.76l-3.23 1.85a7.94 7.94 0 0 0-7.01-4 7.96 7.96 0 0 0-7.97 8.13 7.96 7.96 0 0 0 7.97 8.13 7.94 7.94 0 0 0 7-4l3.24 1.85a11.66 11.66 0 0 1-10.24 5.76Zm13.4-.38h3.52v-7.87c0-3.43 1.8-5.25 4.13-5.25 2.05 0 3.33 1.54 3.33 4.06V96h3.52v-9.63c0-4.07-2.4-6.69-6.11-6.69-2.08 0-3.9.9-4.87 2.5V72h-3.52v24Zm25.56.32c-4.38 0-7.7-3.74-7.7-8.32s3.32-8.32 7.7-8.32c2.3 0 4.23 1.18 5.12 2.46V80h3.52v16h-3.52v-2.14a6.38 6.38 0 0 1-5.12 2.46Zm.64-3.2c2.85 0 4.77-2.24 4.77-5.12s-1.92-5.12-4.77-5.12c-2.84 0-4.76 2.24-4.76 5.12s1.91 5.12 4.76 5.12ZM253.71 96h3.52v-7.8c0-3.2 1.83-4.9 3.84-4.9.64 0 1.15.1 1.76.28v-3.61c-.48-.1-.93-.13-1.37-.13a4.5 4.5 0 0 0-4.23 3V80h-3.52v16Zm21.73-3.33v3.14c-.7.22-1.54.35-2.63.35-3.07 0-5.47-1.7-5.47-5.31v-7.71h-3.33V80h3.33v-4.45h3.52V80h4.58v3.14h-4.58v7.13c0 1.99.86 2.72 2.69 2.72.67 0 1.37-.13 1.89-.32Zm14.21-1.31c0-2.62-1.66-4.03-4.48-4.86l-1.63-.48c-1.57-.45-1.92-1.12-1.92-1.9 0-.95 1.09-1.5 2.15-1.5 1.3 0 2.33.64 3.04 1.64l2.43-1.86c-1.12-1.76-3.01-2.72-5.41-2.72-3.2 0-5.7 1.73-5.73 4.58-.03 2.36 1.41 4.12 4.2 4.9l1.4.38c1.92.57 2.47 1.12 2.47 2.04 0 1.12-1.06 1.7-2.3 1.7-1.64 0-3.2-.8-3.85-2.2l-2.59 1.85c1.15 2.27 3.58 3.39 6.43 3.39 3.3 0 5.8-1.89 5.8-4.96Zm-143.38 21.4c0 .46-.37.84-.83.84a.86.86 0 0 1-.87-.85c0-.46.39-.85.87-.85.46 0 .83.39.83.85Zm-.29 11.24h-1.12v-8h1.12v8Zm-52.02.16a4.04 4.04 0 0 0 3.98-4.16 4.04 4.04 0 0 0-3.98-4.16c-1.24 0-2.39.64-2.96 1.5V112h-1.12v12H91v-1.34c.57.86 1.72 1.5 2.96 1.5Zm-.12-1.04c-1.74 0-2.94-1.4-2.94-3.12 0-1.73 1.2-3.12 2.94-3.12 1.75 0 2.95 1.4 2.95 3.12 0 1.73-1.2 3.12-2.95 3.12Zm7.9 4.22 5.3-11.34h-1.26l-2.93 6.35-2.93-6.35h-1.24l3.55 7.6-1.76 3.74h1.26ZM115.3 124h-1.2v-10.2h-3.68v-1.16h8.56v1.15h-3.68V124Zm3.82 0h1.12v-4.02c0-2.04 1.23-2.94 2.22-2.94.24 0 .45.03.67.11v-1.17a2.44 2.44 0 0 0-2.9 1.66V116h-1.11v8Zm11.72-1.34a3.64 3.64 0 0 1-2.96 1.5 4.04 4.04 0 0 1-3.98-4.16 4.04 4.04 0 0 1 3.98-4.16c1.23 0 2.39.64 2.96 1.5V116h1.12v8h-1.12v-1.34Zm-5.8-2.66c0 1.73 1.2 3.12 2.95 3.12 1.75 0 2.95-1.4 2.95-3.12 0-1.73-1.2-3.12-2.95-3.12-1.74 0-2.94 1.4-2.94 3.12Zm12.98 4.16c1.23 0 2.39-.64 2.96-1.5V124h1.12v-12H141v5.34a3.64 3.64 0 0 0-2.96-1.5 4.04 4.04 0 0 0-3.98 4.16 4.04 4.04 0 0 0 3.98 4.16Zm.11-1.04c-1.74 0-2.94-1.4-2.94-3.12 0-1.73 1.2-3.12 2.94-3.12 1.75 0 2.95 1.4 2.95 3.12 0 1.73-1.2 3.12-2.95 3.12Zm10.6.88h1.11v-3.98c0-1.99 1.1-3.14 2.5-3.14 1.19 0 2.02.86 2.02 2.27V124h1.12v-5c0-1.96-1.27-3.16-3.01-3.16-1.04 0-2.05.45-2.63 1.5V116h-1.11v8Zm16.71-.42c0 2.61-1.72 3.92-3.95 3.92-1.84 0-3.17-.83-3.77-1.74l.88-.75a3.4 3.4 0 0 0 2.9 1.45c1.37 0 2.82-.83 2.82-2.94v-1.02c-.57.86-1.7 1.5-2.92 1.5a3.94 3.94 0 0 1-3.96-4.08 3.94 3.94 0 0 1 3.96-4.08c1.23 0 2.35.64 2.92 1.5V116h1.12v7.58Zm-6.84-3.66c0 1.73 1.16 3.04 2.9 3.04 1.75 0 2.92-1.31 2.92-3.04s-1.17-3.04-2.91-3.04c-1.75 0-2.91 1.31-2.91 3.04Zm13.55 4.08 4.88-11.36h-1.35l-4.03 9.38-4.03-9.38h-1.36l4.9 11.36h.99Zm7.84-11.25c0 .47-.37.85-.83.85a.86.86 0 0 1-.86-.85c0-.46.38-.85.86-.85.47 0 .83.39.83.85Zm-.28 11.25h-1.13v-8h1.13v8Zm6.2.16a3.9 3.9 0 0 0 3.56-1.95l-.91-.6a2.78 2.78 0 0 1-2.64 1.51 2.87 2.87 0 0 1-2.96-2.93h6.75v-.3c-.02-2.56-1.68-4.05-3.76-4.05a4.05 4.05 0 0 0-4.15 4.16c0 2.3 1.6 4.16 4.12 4.16Zm-.01-7.28c1.34 0 2.45.88 2.64 2.32h-5.49a2.84 2.84 0 0 1 2.85-2.32Zm13.55 7.12h-.93l-2.1-6.1-2.14 6.1h-.92l-2.74-8h1.15l2.08 6.08 2.11-6.08h.87l2.11 6.08 2.08-6.08h1.17l-2.74 8Z" fill="currentColor"></path></svg>';
createImageWatermark(chart.panes()[0], imageDataUrl, {
    alpha: 0.5,
    padding: 20,
});

const lineSeries = chart.addSeries(AreaSeries, {
    topColor: '#2962FF',
    bottomColor: 'rgba(41, 98, 255, 0.28)',
    lineColor: '#2962FF',
    lineWidth: 2,
});

const data = [
    { value: 0, time: 1642425322 },
    { value: 8, time: 1642511722 },
    { value: 10, time: 1642598122 },
    { value: 20, time: 1642684522 },
    { value: 3, time: 1642770922 },
    { value: 43, time: 1642857322 },
    { value: 41, time: 1642943722 },
    { value: 43, time: 1643030122 },
    { value: 56, time: 1643116522 },
    { value: 46, time: 1643202922 },
];

lineSeries.setData(data);

chart.timeScale().fitContent();

The code expects the library’s exports, such as createChart, to be imported and a div with the id container on the page. Copy as HTML gives a page that runs on its own.

How it works

An image watermark is a picture drawn behind the series in a pane.

createImageWatermark adds the image to the first pane, from panes. The options set its opacity and padding.
The image here is embedded in the code as a data URL. Usually it is the URL of an image file.

The call is highlighted in the code.

Tips

The image in this example is black on a transparent background, so it is hard to see in dark mode. Use an image that works on both backgrounds, or switch it with the theme.
createImageWatermark centers the image and scales it to fit. To place it any other way, use the plugin from the tip above.

Code​

How it works​

Tips​

Resources​

Code

How it works

Tips

Resources