Skip to main content
Version: Next

Function: createImageWatermark()

createImageWatermark<T>(pane, imageUrl, options): IImageWatermarkPluginApi<T>

Creates an image watermark.

Type parameters​

• T

Parameters​

• pane: IPaneApi<T>

Target pane.

• imageUrl: string

Image URL.

• options: DeepPartial <ImageWatermarkOptions>

Watermark options.

Returns​

IImageWatermarkPluginApi<T>

Image watermark wrapper.

Example​

import { createImageWatermark } from 'lightweight-charts';

const firstPane = chart.panes()[0];
const imageWatermark = createImageWatermark(firstPane, '/images/my-image.png', {
  alpha: 0.5,
  padding: 20,
});
// to change options
imageWatermark.applyOptions({ padding: 10 });
// to remove watermark from the pane
imageWatermark.detach();