diff --git a/.size-limit.js b/.size-limit.js index 7e4e3f3c4a..328ae38200 100644 --- a/.size-limit.js +++ b/.size-limit.js @@ -30,7 +30,7 @@ export default [ brotli: true, }, { - name: 'Standalone-ESM', + name: 'ESM Standalone', path: 'dist/lightweight-charts.standalone.production.mjs', limit: '50.00 KB', import: '*', @@ -42,4 +42,20 @@ export default [ limit: '50.00 KB', brotli: true, }, + { + name: 'Plugin: Text Watermark', + path: 'dist/lightweight-charts.production.mjs', + import: '{ TextWatermark }', + ignore: ['fancy-canvas'], + limit: '2.00 KB', + brotli: true, + }, + { + name: 'Plugin: Image Watermark', + path: 'dist/lightweight-charts.production.mjs', + import: '{ ImageWatermark }', + ignore: ['fancy-canvas'], + limit: '2.00 KB', + brotli: true, + }, ]; diff --git a/src/api/options/chart-options-defaults.ts b/src/api/options/chart-options-defaults.ts index 10c003e58f..3ef44f5464 100644 --- a/src/api/options/chart-options-defaults.ts +++ b/src/api/options/chart-options-defaults.ts @@ -7,7 +7,6 @@ import { gridOptionsDefaults } from './grid-options-defaults'; import { layoutOptionsDefaults } from './layout-options-defaults'; import { priceScaleOptionsDefaults } from './price-scale-options-defaults'; import { timeScaleOptionsDefaults } from './time-scale-options-defaults'; -import { watermarkOptionsDefaults } from './watermark-options-defaults'; export function chartOptionsDefaults(): ChartOptionsInternal { return { @@ -29,7 +28,6 @@ export function chartOptionsDefaults(): ChartOptionsInternal implements IDestroyable, IChartModelBase private readonly _panes: Pane[] = []; private readonly _crosshair: Crosshair; private readonly _magnet: Magnet; - private readonly _watermark: Watermark; private _serieses: Series[] = []; @@ -486,7 +473,6 @@ export class ChartModel implements IDestroyable, IChartModelBase this._timeScale = new TimeScale(this, options.timeScale, this._options.localization, horzScaleBehavior); this._crosshair = new Crosshair(this, options.crosshair); this._magnet = new Magnet(options.crosshair); - this._watermark = new Watermark(this, options.watermark); this._getOrCreatePane(0); this._panes[0].setStretchFactor(DEFAULT_STRETCH_FACTOR * 2); @@ -604,10 +590,6 @@ export class ChartModel implements IDestroyable, IChartModelBase return this._panes; } - public watermarkSource(): Watermark { - return this._watermark; - } - public crosshairSource(): Crosshair { return this._crosshair; } @@ -887,7 +869,6 @@ export class ChartModel implements IDestroyable, IChartModelBase } public recalculateAllPanes(): void { - this._watermark.updateAllViews(); this._panes.forEach((p: Pane) => p.recalculate()); this.updateCrosshair(); } diff --git a/src/model/watermark.ts b/src/model/watermark.ts deleted file mode 100644 index 0cb88ca98e..0000000000 --- a/src/model/watermark.ts +++ /dev/null @@ -1,93 +0,0 @@ -import { HorzAlign, VertAlign } from '../renderers/watermark-renderer'; -import { IPaneView } from '../views/pane/ipane-view'; -import { WatermarkPaneView } from '../views/pane/watermark-pane-view'; -import { IPriceAxisView } from '../views/price-axis/iprice-axis-view'; - -import { IChartModelBase } from './chart-model'; -import { DataSource } from './data-source'; - -/** Watermark options. */ -export interface WatermarkOptions { - /** - * Watermark color. - * - * @defaultValue `'rgba(0, 0, 0, 0)'` - */ - color: string; - - /** - * Display the watermark. - * - * @defaultValue `false` - */ - visible: boolean; - - /** - * Text of the watermark. Word wrapping is not supported. - * - * @defaultValue `''` - */ - text: string; - - /** - * Font size in pixels. - * - * @defaultValue `48` - */ - fontSize: number; - - /** - * Font family. - * - * @defaultValue `-apple-system, BlinkMacSystemFont, 'Trebuchet MS', Roboto, Ubuntu, sans-serif` - */ - fontFamily: string; - - /** - * Font style. - * - * @defaultValue `''` - */ - fontStyle: string; - - /** - * Horizontal alignment inside the chart area. - * - * @defaultValue `'center'` - */ - horzAlign: HorzAlign; - - /** - * Vertical alignment inside the chart area. - * - * @defaultValue `'center'` - */ - vertAlign: VertAlign; -} - -export class Watermark extends DataSource { - private readonly _paneView: WatermarkPaneView; - private readonly _options: WatermarkOptions; - - public constructor(model: IChartModelBase, options: WatermarkOptions) { - super(); - this._options = options; - this._paneView = new WatermarkPaneView(this); - } - - public override priceAxisViews(): readonly IPriceAxisView[] { - return []; - } - - public paneViews(): readonly IPaneView[] { - return [this._paneView]; - } - - public options(): Readonly { - return this._options; - } - - public updateAllViews(): void { - this._paneView.update(); - } -} diff --git a/src/plugins/image-watermark/options.ts b/src/plugins/image-watermark/options.ts new file mode 100644 index 0000000000..a2417bf222 --- /dev/null +++ b/src/plugins/image-watermark/options.ts @@ -0,0 +1,33 @@ +export interface ImageWatermarkOptions { + /** + * Maximum width for the image watermark. + * + * @defaultValue undefined + */ + maxWidth?: number; + /** + * Maximum height for the image watermark. + * + * @defaultValue undefined + */ + maxHeight?: number; + /** + * Padding to maintain around the image watermark relative + * to the chart pane edges. + * + * @defaultValue 0 + */ + padding: number; + /** + * The alpha (opacity) for the image watermark. Where `1` is fully + * opaque (visible) and `0` is fully transparent. + * + * @defaultValue 1 + */ + alpha: number; +} + +export const imageWatermarkOptionsDefaults: ImageWatermarkOptions = { + alpha: 1, + padding: 0, +}; diff --git a/src/plugins/image-watermark/pane-renderer.ts b/src/plugins/image-watermark/pane-renderer.ts new file mode 100644 index 0000000000..e676e4fe6b --- /dev/null +++ b/src/plugins/image-watermark/pane-renderer.ts @@ -0,0 +1,43 @@ +import { + CanvasRenderingTarget2D, + MediaCoordinatesRenderingScope, +} from 'fancy-canvas'; + +import { IPrimitivePaneRenderer } from '../../model/ipane-primitive'; + +import { ImageWatermarkOptions } from './options'; + +export interface Placement { + x: number; + y: number; + height: number; + width: number; +} + +export interface ImageWatermarkRendererOptions extends ImageWatermarkOptions { + placement: Placement | null; + imgElement: HTMLImageElement | null; +} + +export class ImageWatermarkRenderer implements IPrimitivePaneRenderer { + private _data: ImageWatermarkRendererOptions; + + public constructor(data: ImageWatermarkRendererOptions) { + this._data = data; + } + + public draw(target: CanvasRenderingTarget2D): void { + target.useMediaCoordinateSpace((scope: MediaCoordinatesRenderingScope) => { + const ctx = scope.context; + const pos = this._data.placement; + if (!pos) { + return; + } + if (!this._data.imgElement) { + throw new Error(`Image element missing.`); + } + ctx.globalAlpha = this._data.alpha ?? 1; + ctx.drawImage(this._data.imgElement, pos.x, pos.y, pos.width, pos.height); + }); + } +} diff --git a/src/plugins/image-watermark/pane-view.ts b/src/plugins/image-watermark/pane-view.ts new file mode 100644 index 0000000000..2d31b7db4c --- /dev/null +++ b/src/plugins/image-watermark/pane-view.ts @@ -0,0 +1,133 @@ +import { IChartApiBase } from '../../api/ichart-api'; + +import { + IPrimitivePaneRenderer, + IPrimitivePaneView, + PrimitivePaneViewZOrder, +} from '../../model/ipane-primitive'; + +import { ImageWatermarkOptions } from './options'; +import { + ImageWatermarkRenderer, + ImageWatermarkRendererOptions, + Placement, +} from './pane-renderer'; + +interface ImageWatermarkPaneViewState { + image: HTMLImageElement | null; + imageWidth: number; + imageHeight: number; + chart: IChartApiBase | null; +} + +export class ImageWatermarkPaneView implements IPrimitivePaneView { + private _options: ImageWatermarkOptions; + private _rendererOptions: ImageWatermarkRendererOptions; + private _image: HTMLImageElement | null = null; + private _imageWidth: number = 0; // don't draw until loaded + private _imageHeight: number = 0; + private _chart: IChartApiBase | null = null; + private _placement: Placement | null = null; + + public constructor(options: ImageWatermarkOptions) { + this._options = options; + this._rendererOptions = buildRendererOptions( + this._options, + this._placement, + this._image + ); + } + + public stateUpdate(state: ImageWatermarkPaneViewState): void { + if (state.chart !== undefined) { + this._chart = state.chart; + } + if (state.imageWidth !== undefined) { + this._imageWidth = state.imageWidth; + } + if (state.imageHeight !== undefined) { + this._imageHeight = state.imageHeight; + } + if (state.image !== undefined) { + this._image = state.image; + } + this.update(); + } + + public optionsUpdate(options: ImageWatermarkOptions): void { + this._options = options; + this.update(); + } + + public zOrder(): PrimitivePaneViewZOrder { + return 'bottom' satisfies PrimitivePaneViewZOrder; + } + + public update(): void { + this._placement = this._determinePlacement(); + this._rendererOptions = buildRendererOptions( + this._options, + this._placement, + this._image + ); + } + + public renderer(): IPrimitivePaneRenderer { + return new ImageWatermarkRenderer(this._rendererOptions); + } + + private _determinePlacement(): Placement | null { + if (!this._chart || !this._imageWidth || !this._imageHeight) { + return null; + } + const leftPriceScaleWidth = this._chart.priceScale('left').width(); + const plotAreaWidth = this._chart.timeScale().width(); + const startX = leftPriceScaleWidth; + const plotAreaHeight = + this._chart.chartElement().clientHeight - + this._chart.timeScale().height(); + + const plotCentreX = Math.round(plotAreaWidth / 2) + startX; + const plotCentreY = Math.round(plotAreaHeight / 2) + 0; + + const padding = this._options.padding ?? 0; + let availableWidth = plotAreaWidth - 2 * padding; + let availableHeight = plotAreaHeight - 2 * padding; + + if (this._options.maxHeight) { + availableHeight = Math.min(availableHeight, this._options.maxHeight); + } + if (this._options.maxWidth) { + availableWidth = Math.min(availableWidth, this._options.maxWidth); + } + + const scaleX = availableWidth / this._imageWidth; + const scaleY = availableHeight / this._imageHeight; + const scaleToUse = Math.min(scaleX, scaleY); + + const drawWidth = this._imageWidth * scaleToUse; + const drawHeight = this._imageHeight * scaleToUse; + + const x = plotCentreX - 0.5 * drawWidth; + const y = plotCentreY - 0.5 * drawHeight; + + return { + x, + y, + height: drawHeight, + width: drawWidth, + }; + } +} + +function buildRendererOptions( + options: ImageWatermarkOptions, + placement: Placement | null, + imgElement: HTMLImageElement | null +): ImageWatermarkRendererOptions { + return { + ...options, + placement, + imgElement, + }; +} diff --git a/src/plugins/image-watermark/primitive.ts b/src/plugins/image-watermark/primitive.ts new file mode 100644 index 0000000000..5cbdcef134 --- /dev/null +++ b/src/plugins/image-watermark/primitive.ts @@ -0,0 +1,112 @@ +import { + IPanePrimitive, + PaneAttachedParameter, +} from '../../api/ipane-primitive-api'; + +import { DeepPartial } from '../../helpers/strict-type-checks'; + +import { Time } from '../../model/horz-scale-behavior-time/types'; +import { IPanePrimitivePaneView } from '../../model/ipane-primitive'; + +import { + ImageWatermarkOptions, + imageWatermarkOptionsDefaults, +} from './options'; +import { ImageWatermarkPaneView } from './pane-view'; + +function mergeOptionsWithDefaults( + options: DeepPartial +): ImageWatermarkOptions { + return { + ...imageWatermarkOptionsDefaults, + ...options, + }; +} + +/** + * A pane primitive for rendering a image watermark. + * + * @example + * ```js + * import { ImageWatermark } from 'lightweight-charts'; + * + * const imageWatermark = new ImageWatermark('/images/my-image.png', { + * alpha: 0.5, + * padding: 20, + * }); + * + * const firstPane = chart.panes()[0]; + * firstPane.attachPrimitive(imageWatermark); + * ``` + */ +export class ImageWatermark implements IPanePrimitive { + private _requestUpdate?: () => void; + private _paneViews: ImageWatermarkPaneView[]; + private _options: ImageWatermarkOptions; + private _imgElement: HTMLImageElement | null = null; + private _imageUrl: string; + + public constructor( + imageUrl: string, + options: DeepPartial + ) { + this._imageUrl = imageUrl; + this._options = mergeOptionsWithDefaults(options); + this._paneViews = [new ImageWatermarkPaneView(this._options)]; + } + + public updateAllViews(): void { + this._paneViews.forEach((pw: ImageWatermarkPaneView) => pw.update()); + } + + public paneViews(): readonly IPanePrimitivePaneView[] { + return this._paneViews; + } + + public attached(attachedParams: PaneAttachedParameter): void { + const { requestUpdate, chart } = attachedParams; + this._requestUpdate = requestUpdate; + this._imgElement = new Image(); + this._imgElement.onload = () => { + const imageHeight = this._imgElement?.naturalHeight ?? 1; + const imageWidth = this._imgElement?.naturalWidth ?? 1; + this._paneViews.forEach((pv: ImageWatermarkPaneView) => + pv.stateUpdate({ + imageHeight, + imageWidth, + image: this._imgElement, + chart, + }) + ); + if (this._requestUpdate) { + this._requestUpdate(); + } + }; + this._imgElement.src = this._imageUrl; + } + + public detached(): void { + this._requestUpdate = undefined; + this._imgElement = null; + } + + public applyOptions(options: DeepPartial): void { + this._options = mergeOptionsWithDefaults({ ...this._options, ...options }); + this._updateOptions(); + if (this.requestUpdate) { + this.requestUpdate(); + } + } + + public requestUpdate(): void { + if (this._requestUpdate) { + this._requestUpdate(); + } + } + + private _updateOptions(): void { + this._paneViews.forEach((pw: ImageWatermarkPaneView) => + pw.optionsUpdate(this._options) + ); + } +} diff --git a/src/plugins/text-watermark/options.ts b/src/plugins/text-watermark/options.ts new file mode 100644 index 0000000000..d35cc26d63 --- /dev/null +++ b/src/plugins/text-watermark/options.ts @@ -0,0 +1,93 @@ +import { defaultFontFamily } from '../../helpers/make-font'; + +import { HorzAlign, VertAlign } from '../types'; + +export interface TextWatermarkOptions { + /** + * Display the watermark. + * + * @defaultValue `true` + */ + visible: boolean; + + /** + * Horizontal alignment inside the chart area. + * + * @defaultValue `'center'` + */ + horzAlign: HorzAlign; + + /** + * Vertical alignment inside the chart area. + * + * @defaultValue `'center'` + */ + vertAlign: VertAlign; + + /** + * Text to be displayed within the watermark. Each item + * in the array is treated as new line. + * + * @defaultValue `[]` + */ + lines: TextWatermarkLineOptions[]; +} + +export interface TextWatermarkLineOptions { + /** + * Watermark color. + * + * @defaultValue `'rgba(0, 0, 0, 0.5)'` + */ + + color: string; + /** + * Text of the watermark. Word wrapping is not supported. + * + * @defaultValue `''` + */ + text: string; + + /** + * Font size in pixels. + * + * @defaultValue `48` + */ + fontSize: number; + + /** + * Line height in pixels. + * + * @defaultValue `1.2 * fontSize` + */ + lineHeight?: number; + + /** + * Font family. + * + * @defaultValue `-apple-system, BlinkMacSystemFont, 'Trebuchet MS', Roboto, Ubuntu, sans-serif` + */ + fontFamily: string; + + /** + * Font style. + * + * @defaultValue `''` + */ + fontStyle: string; +} + +export const textWatermarkOptionsDefaults: TextWatermarkOptions = { + visible: true, + horzAlign: 'center', + vertAlign: 'center', + lines: [], +}; + +export const textWatermarkLineOptionsDefaults: TextWatermarkLineOptions = { + color: 'rgba(0, 0, 0, 0.5)', + fontSize: 48, + fontFamily: defaultFontFamily, + fontStyle: '', + text: '', +}; diff --git a/src/plugins/text-watermark/pane-renderer.ts b/src/plugins/text-watermark/pane-renderer.ts new file mode 100644 index 0000000000..186089f5a7 --- /dev/null +++ b/src/plugins/text-watermark/pane-renderer.ts @@ -0,0 +1,118 @@ +import { + CanvasRenderingTarget2D, + MediaCoordinatesRenderingScope, +} from 'fancy-canvas'; + +import { IPrimitivePaneRenderer } from '../../model/ipane-primitive'; + +import { TextWatermarkLineOptions, TextWatermarkOptions } from './options'; + +export interface TextWatermarkLineRendererOptions + extends TextWatermarkLineOptions { + zoom: number; + vertOffset: number; + font: string; + lineHeight: number; +} + +export interface TextWatermarkRendererOptions extends TextWatermarkOptions { + lines: TextWatermarkLineRendererOptions[]; +} + +export class TextWatermarkRenderer implements IPrimitivePaneRenderer { + private _data: TextWatermarkRendererOptions; + private _metricsCache: Map> = new Map(); + + public constructor(options: TextWatermarkRendererOptions) { + this._data = options; + } + + public draw(target: CanvasRenderingTarget2D): void { + target.useMediaCoordinateSpace((scope: MediaCoordinatesRenderingScope) => { + const { context: ctx, mediaSize } = scope; + + let textHeight = 0; + for (const line of this._data.lines) { + if (line.text.length === 0) { + continue; + } + + ctx.font = line.font; + const textWidth = this._metrics(ctx, line.text); + if (textWidth > mediaSize.width) { + line.zoom = mediaSize.width / textWidth; + } else { + line.zoom = 1; + } + + textHeight += line.lineHeight * line.zoom; + } + + let vertOffset = 0; + switch (this._data.vertAlign) { + case 'top': + vertOffset = 0; + break; + + case 'center': + vertOffset = Math.max((mediaSize.height - textHeight) / 2, 0); + break; + + case 'bottom': + vertOffset = Math.max(mediaSize.height - textHeight, 0); + break; + } + + for (const line of this._data.lines) { + ctx.save(); + ctx.fillStyle = line.color; + let horzOffset = 0; + switch (this._data.horzAlign) { + case 'left': + ctx.textAlign = 'left'; + horzOffset = line.lineHeight / 2; + break; + + case 'center': + ctx.textAlign = 'center'; + horzOffset = mediaSize.width / 2; + break; + + case 'right': + ctx.textAlign = 'right'; + horzOffset = mediaSize.width - 1 - line.lineHeight / 2; + break; + } + + ctx.translate(horzOffset, vertOffset); + ctx.textBaseline = 'top'; + ctx.font = line.font; + ctx.scale(line.zoom, line.zoom); + ctx.fillText(line.text, 0, line.vertOffset); + ctx.restore(); + vertOffset += line.lineHeight * line.zoom; + } + }); + } + + private _metrics(ctx: CanvasRenderingContext2D, text: string): number { + const fontCache = this._fontCache(ctx.font); + let result = fontCache.get(text); + if (result === undefined) { + result = ctx.measureText(text).width; + fontCache.set(text, result); + } + + return result; + } + + private _fontCache(font: string): Map { + let fontCache = this._metricsCache.get(font); + if (fontCache === undefined) { + fontCache = new Map(); + this._metricsCache.set(font, fontCache); + } + + return fontCache; + } +} diff --git a/src/plugins/text-watermark/pane-view.ts b/src/plugins/text-watermark/pane-view.ts new file mode 100644 index 0000000000..46ec02e96d --- /dev/null +++ b/src/plugins/text-watermark/pane-view.ts @@ -0,0 +1,54 @@ +import { makeFont } from '../../helpers/make-font'; + +import { + IPrimitivePaneRenderer, + IPrimitivePaneView, +} from '../../model/ipane-primitive'; + +import { TextWatermarkLineOptions, TextWatermarkOptions } from './options'; +import { + TextWatermarkLineRendererOptions, + TextWatermarkRenderer, + TextWatermarkRendererOptions, +} from './pane-renderer'; + +export class TextWatermarkPaneView implements IPrimitivePaneView { + private _options: TextWatermarkRendererOptions; + + public constructor(options: TextWatermarkOptions) { + this._options = buildRendererOptions(options); + } + + public update(options: TextWatermarkOptions): void { + this._options = buildRendererOptions(options); + } + + public renderer(): IPrimitivePaneRenderer { + return new TextWatermarkRenderer(this._options); + } +} + +function buildRendererLineOptions( + lineOption: TextWatermarkLineOptions +): TextWatermarkLineRendererOptions { + return { + ...lineOption, + font: makeFont( + lineOption.fontSize, + lineOption.fontFamily, + lineOption.fontStyle + ), + lineHeight: lineOption.lineHeight || lineOption.fontSize * 1.2, + vertOffset: 0, + zoom: 0, + }; +} + +function buildRendererOptions( + options: TextWatermarkOptions +): TextWatermarkRendererOptions { + return { + ...options, + lines: options.lines.map(buildRendererLineOptions), + }; +} diff --git a/src/plugins/text-watermark/primitive.ts b/src/plugins/text-watermark/primitive.ts new file mode 100644 index 0000000000..3892b5107f --- /dev/null +++ b/src/plugins/text-watermark/primitive.ts @@ -0,0 +1,99 @@ +import { + IPanePrimitive, + PaneAttachedParameter, +} from '../../api/ipane-primitive-api'; + +import { DeepPartial } from '../../helpers/strict-type-checks'; + +import { Time } from '../../model/horz-scale-behavior-time/types'; +import { IPanePrimitivePaneView } from '../../model/ipane-primitive'; + +import { + TextWatermarkLineOptions, + textWatermarkLineOptionsDefaults, + TextWatermarkOptions, + textWatermarkOptionsDefaults, +} from './options'; +import { TextWatermarkPaneView } from './pane-view'; + +function mergeLineOptionsWithDefaults( + options: Partial +): TextWatermarkLineOptions { + return { + ...textWatermarkLineOptionsDefaults, + ...options, + }; +} + +function mergeOptionsWithDefaults( + options: DeepPartial +): TextWatermarkOptions { + return { + ...textWatermarkOptionsDefaults, + ...options, + lines: options.lines?.map(mergeLineOptionsWithDefaults) ?? [], + }; +} + +/** + * A pane primitive for rendering a text watermark. + * + * @example + * ```js + * const textWatermark = new TextWatermark({ + * horzAlign: 'center', + * vertAlign: 'center', + * lines: [ + * { + * text: 'Hello', + * color: 'rgba(255,0,0,0.5)', + * fontSize: 100, + * fontStyle: 'bold', + * }, + * { + * text: 'This is a text watermark', + * color: 'rgba(0,0,255,0.5)', + * fontSize: 50, + * fontStyle: 'italic', + * fontFamily: 'monospace', + * }, + * ], + * }); + * chart.panes()[0].attachPrimitive(textWatermark); + * ``` + */ +export class TextWatermark implements IPanePrimitive { + public requestUpdate?: () => void; + private _paneViews: TextWatermarkPaneView[]; + private _options: TextWatermarkOptions; + + public constructor(options: DeepPartial) { + this._options = mergeOptionsWithDefaults(options); + this._paneViews = [new TextWatermarkPaneView(this._options)]; + } + + public updateAllViews(): void { + this._paneViews.forEach((pw: TextWatermarkPaneView) => + pw.update(this._options) + ); + } + + public paneViews(): readonly IPanePrimitivePaneView[] { + return this._paneViews; + } + + public attached({ requestUpdate }: PaneAttachedParameter): void { + this.requestUpdate = requestUpdate; + } + + public detached(): void { + this.requestUpdate = undefined; + } + + public applyOptions(options: DeepPartial): void { + this._options = mergeOptionsWithDefaults({ ...this._options, ...options }); + if (this.requestUpdate) { + this.requestUpdate(); + } + } +} diff --git a/src/plugins/types.ts b/src/plugins/types.ts new file mode 100644 index 0000000000..b6f88ff426 --- /dev/null +++ b/src/plugins/types.ts @@ -0,0 +1,8 @@ +/** + * Represents a horizontal alignment. + */ +export type HorzAlign = 'left' | 'center' | 'right'; +/** + * Represents a vertical alignment. + */ +export type VertAlign = 'top' | 'center' | 'bottom'; diff --git a/src/renderers/watermark-renderer.ts b/src/renderers/watermark-renderer.ts deleted file mode 100644 index 3e43a35259..0000000000 --- a/src/renderers/watermark-renderer.ts +++ /dev/null @@ -1,133 +0,0 @@ -import { MediaCoordinatesRenderingScope } from 'fancy-canvas'; - -import { MediaCoordinatesPaneRenderer } from './media-coordinates-pane-renderer'; - -export interface WatermarkRendererLineData { - text: string; - font: string; - lineHeight: number; - vertOffset: number; - zoom: number; -} - -/** - * Represents a horizontal alignment. - */ -export type HorzAlign = 'left' | 'center' | 'right'; -/** - * Represents a vertical alignment. - */ -export type VertAlign = 'top' | 'center' | 'bottom'; - -export interface WatermarkRendererData { - lines: WatermarkRendererLineData[]; - color: string; - visible: boolean; - horzAlign: HorzAlign; - vertAlign: VertAlign; -} - -export class WatermarkRenderer extends MediaCoordinatesPaneRenderer { - private readonly _data: WatermarkRendererData; - private _metricsCache: Map> = new Map(); - - public constructor(data: WatermarkRendererData) { - super(); - this._data = data; - } - - protected _drawImpl(renderingScope: MediaCoordinatesRenderingScope): void {} - - protected override _drawBackgroundImpl(renderingScope: MediaCoordinatesRenderingScope): void { - if (!this._data.visible) { - return; - } - - const { context: ctx, mediaSize } = renderingScope; - - let textHeight = 0; - for (const line of this._data.lines) { - if (line.text.length === 0) { - continue; - } - - ctx.font = line.font; - const textWidth = this._metrics(ctx, line.text); - if (textWidth > mediaSize.width) { - line.zoom = mediaSize.width / textWidth; - } else { - line.zoom = 1; - } - - textHeight += line.lineHeight * line.zoom; - } - - let vertOffset = 0; - switch (this._data.vertAlign) { - case 'top': - vertOffset = 0; - break; - - case 'center': - vertOffset = Math.max((mediaSize.height - textHeight) / 2, 0); - break; - - case 'bottom': - vertOffset = Math.max((mediaSize.height - textHeight), 0); - break; - } - - ctx.fillStyle = this._data.color; - - for (const line of this._data.lines) { - ctx.save(); - - let horzOffset = 0; - switch (this._data.horzAlign) { - case 'left': - ctx.textAlign = 'left'; - horzOffset = line.lineHeight / 2; - break; - - case 'center': - ctx.textAlign = 'center'; - horzOffset = mediaSize.width / 2; - break; - - case 'right': - ctx.textAlign = 'right'; - horzOffset = mediaSize.width - 1 - line.lineHeight / 2; - break; - } - - ctx.translate(horzOffset, vertOffset); - ctx.textBaseline = 'top'; - ctx.font = line.font; - ctx.scale(line.zoom, line.zoom); - ctx.fillText(line.text, 0, line.vertOffset); - ctx.restore(); - vertOffset += line.lineHeight * line.zoom; - } - } - - private _metrics(ctx: CanvasRenderingContext2D, text: string): number { - const fontCache = this._fontCache(ctx.font); - let result = fontCache.get(text); - if (result === undefined) { - result = ctx.measureText(text).width; - fontCache.set(text, result); - } - - return result; - } - - private _fontCache(font: string): Map { - let fontCache = this._metricsCache.get(font); - if (fontCache === undefined) { - fontCache = new Map(); - this._metricsCache.set(font, fontCache); - } - - return fontCache; - } -} diff --git a/src/tsconfig.composite.json b/src/tsconfig.composite.json index 8ca4c042d1..4906c1a091 100644 --- a/src/tsconfig.composite.json +++ b/src/tsconfig.composite.json @@ -8,6 +8,7 @@ { "path": "./tsconfig.model.json" } ], "include": [ + "./plugins/**/*.ts", "./index.ts", "./standalone.ts" ] diff --git a/src/views/pane/watermark-pane-view.ts b/src/views/pane/watermark-pane-view.ts deleted file mode 100644 index d3d94d1ddd..0000000000 --- a/src/views/pane/watermark-pane-view.ts +++ /dev/null @@ -1,62 +0,0 @@ -import { makeFont } from '../../helpers/make-font'; - -import { Watermark } from '../../model/watermark'; -import { IPaneRenderer } from '../../renderers/ipane-renderer'; -import { WatermarkRenderer, WatermarkRendererData } from '../../renderers/watermark-renderer'; - -import { IUpdatablePaneView } from './iupdatable-pane-view'; - -export class WatermarkPaneView implements IUpdatablePaneView { - private _source: Watermark; - private _invalidated: boolean = true; - - private readonly _rendererData: WatermarkRendererData = { - visible: false, - color: '', - lines: [], - vertAlign: 'center', - horzAlign: 'center', - }; - private readonly _renderer: WatermarkRenderer = new WatermarkRenderer(this._rendererData); - - public constructor(source: Watermark) { - this._source = source; - } - - public update(): void { - this._invalidated = true; - } - - public renderer(): IPaneRenderer { - if (this._invalidated) { - this._updateImpl(); - this._invalidated = false; - } - - return this._renderer; - } - - private _updateImpl(): void { - const options = this._source.options(); - const data = this._rendererData; - data.visible = options.visible; - - if (!data.visible) { - return; - } - - data.color = options.color; - data.horzAlign = options.horzAlign; - data.vertAlign = options.vertAlign; - - data.lines = [ - { - text: options.text, - font: makeFont(options.fontSize, options.fontFamily, options.fontStyle), - lineHeight: options.fontSize * 1.2, - vertOffset: 0, - zoom: 0, - }, - ]; - } -} diff --git a/tests/e2e/coverage/test-cases/chart/watermark.js b/tests/e2e/coverage/test-cases/chart/watermark.js deleted file mode 100644 index 17f5285bf0..0000000000 --- a/tests/e2e/coverage/test-cases/chart/watermark.js +++ /dev/null @@ -1,53 +0,0 @@ -function simpleData() { - return [ - { time: 1663740000, value: 10 }, - { time: 1663750000, value: 20 }, - { time: 1663760000, value: 30 }, - ]; -} - -function interactionsToPerform() { - return []; -} - -let chart; - -function beforeInteractions(container) { - chart = LightweightCharts.createChart(container, { - watermark: { - visible: true, - color: 'red', - text: 'Watermark', - fontSize: 24, - fontStyle: 'italic', - }, - }); - - const mainSeries = chart.addLineSeries(); - - mainSeries.setData(simpleData()); - - return Promise.resolve(); -} - -function afterInteractions() { - chart.applyOptions({ - watermark: { - fontFamily: 'Roboto', - horzAlign: 'left', - vertAlign: 'top', - }, - }); - - return new Promise(resolve => { - requestAnimationFrame(() => { - chart.applyOptions({ - watermark: { - horzAlign: 'right', - vertAlign: 'bottom', - }, - }); - }); - requestAnimationFrame(resolve); - }); -} diff --git a/tests/e2e/coverage/test-cases/plugins/text-watermark.js b/tests/e2e/coverage/test-cases/plugins/text-watermark.js new file mode 100644 index 0000000000..4c16bb78d5 --- /dev/null +++ b/tests/e2e/coverage/test-cases/plugins/text-watermark.js @@ -0,0 +1,64 @@ +function simpleData() { + return [ + { time: 1663740000, value: 10 }, + { time: 1663750000, value: 20 }, + { time: 1663760000, value: 30 }, + ]; +} + +function interactionsToPerform() { + return []; +} + +let chart; +let textWatermark; + +function beforeInteractions(container) { + chart = LightweightCharts.createChart(container); + + const mainSeries = chart.addLineSeries(); + + mainSeries.setData(simpleData()); + + textWatermark = new LightweightCharts.TextWatermark({ + horzAlign: 'center', + vertAlign: 'center', + lines: [ + { + text: 'Hello', + color: 'rgba(255,0,0,0.5)', + fontSize: 100, + fontStyle: 'bold', + }, + { + text: 'This is a text watermark', + color: 'rgba(0,0,255,0.5)', + fontSize: 50, + fontStyle: 'italic', + fontFamily: 'monospace', + }, + ], + }); + + const pane = chart.panes()[0]; + pane.attachPrimitive(textWatermark); + + return Promise.resolve(); +} + +function afterInteractions() { + textWatermark.applyOptions({ + horzAlign: 'left', + vertAlign: 'top', + }); + + return new Promise(resolve => { + requestAnimationFrame(() => { + textWatermark.applyOptions({ + horzAlign: 'right', + vertAlign: 'bottom', + }); + }); + requestAnimationFrame(resolve); + }); +} diff --git a/tests/e2e/graphics/test-cases/api/series-markers.js b/tests/e2e/graphics/test-cases/api/series-markers.js index b06dfe62ab..6880723234 100644 --- a/tests/e2e/graphics/test-cases/api/series-markers.js +++ b/tests/e2e/graphics/test-cases/api/series-markers.js @@ -40,13 +40,16 @@ function runTestCase(container) { series.setMarkers(markers); const seriesApiMarkers = series.markers(); - chart.applyOptions({ - watermark: { - color: 'red', - visible: true, - text: JSON.stringify(seriesApiMarkers[0]), - }, + const textWatermark = new LightweightCharts.TextWatermark({ + lines: [ + { + text: JSON.stringify(seriesApiMarkers[0]), + color: 'red', + }, + ], }); + const pane = chart.panes()[0]; + pane.attachPrimitive(textWatermark); console.assert(compare(markers, seriesApiMarkers), `series.markers() should return exactly the same that was provided to series.setMarkers()\n${JSON.stringify(seriesApiMarkers)}\n${JSON.stringify(markers)}`); } diff --git a/tests/e2e/graphics/test-cases/api/subscribe-crosshair-move.js b/tests/e2e/graphics/test-cases/api/subscribe-crosshair-move.js index 0592dd6e64..9e03dda8a5 100644 --- a/tests/e2e/graphics/test-cases/api/subscribe-crosshair-move.js +++ b/tests/e2e/graphics/test-cases/api/subscribe-crosshair-move.js @@ -1,5 +1,7 @@ function runTestCase(container) { - const chart = window.chart = LightweightCharts.createChart(container, { layout: { attributionLogo: false } }); + const chart = (window.chart = LightweightCharts.createChart(container, { + layout: { attributionLogo: false }, + })); const series = chart.addAreaSeries(); series.setData([ { time: '1990-04-24', value: 0 }, @@ -12,15 +14,29 @@ function runTestCase(container) { chart.timeScale().fitContent(); + const textWatermark = new LightweightCharts.TextWatermark({ + lines: [ + { + text: '', + color: 'red', + fontSize: 12, + }, + ], + }); + const pane = chart.panes()[0]; + pane.attachPrimitive(textWatermark); + chart.subscribeCrosshairMove(param => { if (param.time) { const seriesData = param.seriesData.get(series) || {}; - chart.applyOptions({ - watermark: { - color: 'red', - visible: true, - text: `${param.time} - ${seriesData.time}`, - }, + textWatermark.applyOptions({ + lines: [ + { + text: `${param.time} - ${seriesData.time}`, + color: 'red', + fontSize: 12, + }, + ], }); } }); diff --git a/tests/e2e/graphics/test-cases/applying-options/watermark.js b/tests/e2e/graphics/test-cases/applying-options/watermark.js index 4f4dacb688..eddc3b25c5 100644 --- a/tests/e2e/graphics/test-cases/applying-options/watermark.js +++ b/tests/e2e/graphics/test-cases/applying-options/watermark.js @@ -22,26 +22,46 @@ function generateData() { return res; } +let textWatermark; + function runTestCase(container) { - const chart = window.chart = LightweightCharts.createChart(container, { layout: { attributionLogo: false } }); + const chart = (window.chart = LightweightCharts.createChart(container, { + layout: { attributionLogo: false }, + })); const mainSeries = chart.addCandlestickSeries(); mainSeries.setData(generateData()); + textWatermark = new LightweightCharts.TextWatermark({ + horzAlign: 'left', + vertAlign: 'bottom', + lines: [ + { + text: 'Watermark Before', + color: 'rgba(0, 0, 0, 0.5)', + fontSize: 12, + }, + ], + }); + const pane = chart.panes()[0]; + pane.attachPrimitive(textWatermark); + return new Promise(resolve => { setTimeout(() => { - chart.applyOptions({ - watermark: { - visible: true, - fontSize: 24, - horzAlign: 'center', - vertAlign: 'center', - color: 'rgba(171, 71, 188, 0.5)', - text: 'Watermark', - fontFamily: 'Roboto', - fontStyle: 'bold', - }, + textWatermark.applyOptions({ + visible: true, + horzAlign: 'center', + vertAlign: 'center', + lines: [ + { + text: 'Watermark', + color: 'rgba(171, 71, 188, 0.5)', + fontSize: 24, + fontFamily: 'Roboto', + fontStyle: 'bold', + }, + ], }); resolve(); }, 300); diff --git a/tests/e2e/graphics/test-cases/initial-options/watermark.js b/tests/e2e/graphics/test-cases/initial-options/watermark.js index 19c135d485..e48f1f7b7d 100644 --- a/tests/e2e/graphics/test-cases/initial-options/watermark.js +++ b/tests/e2e/graphics/test-cases/initial-options/watermark.js @@ -13,19 +13,26 @@ function generateData() { } function runTestCase(container) { - const chart = window.chart = LightweightCharts.createChart(container, { - watermark: { - visible: true, - color: 'red', - text: 'TradingView Watermark Example', - fontSize: 24, - fontFamily: 'Roboto', - fontStyle: 'italic', - }, + const chart = (window.chart = LightweightCharts.createChart(container, { layout: { attributionLogo: false }, - }); + })); const mainSeries = chart.addAreaSeries(); - mainSeries.setData(generateData()); + + const textWatermark = new LightweightCharts.TextWatermark({ + visible: true, + lines: [ + { + color: 'red', + text: 'TradingView Watermark Example', + fontSize: 24, + fontFamily: 'Roboto', + fontStyle: 'italic', + }, + ], + }); + + const pane = chart.panes()[0]; + pane.attachPrimitive(textWatermark); } diff --git a/tests/e2e/graphics/test-cases/plugins/image-watermark.js b/tests/e2e/graphics/test-cases/plugins/image-watermark.js new file mode 100644 index 0000000000..0e2fd8a905 --- /dev/null +++ b/tests/e2e/graphics/test-cases/plugins/image-watermark.js @@ -0,0 +1,81 @@ +function generateData() { + const res = []; + const time = new Date(Date.UTC(2018, 0, 1, 0, 0, 0, 0)); + for (let i = 0; i < 500; ++i) { + res.push({ + time: time.getTime() / 1000, + value: i, + }); + + time.setUTCDate(time.getUTCDate() + 1); + } + return res; +} + +function svgToDataUrl(svgString) { + // Encode the SVG string + const encodedSvg = encodeURIComponent(svgString); + + // Create the data URL + const dataUrl = `data:image/svg+xml;charset=utf-8,${encodedSvg}`; + + return dataUrl; +} + +const svgString = ` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +`; + +const imageDataUrl = svgToDataUrl(svgString); + +function runTestCase(container) { + const chart = (window.chart = LightweightCharts.createChart(container, { + layout: { attributionLogo: false }, + })); + + const mainSeries = chart.addAreaSeries(); + mainSeries.setData(generateData()); + + const imageWatermark = new LightweightCharts.ImageWatermark(imageDataUrl, { + alpha: 0.5, + padding: 20, + }); + + const pane = chart.panes()[0]; + pane.attachPrimitive(imageWatermark); +} diff --git a/tests/type-checks/non-time-based-custom-series.ts b/tests/type-checks/non-time-based-custom-series.ts index 0453b9d212..a30145a361 100644 --- a/tests/type-checks/non-time-based-custom-series.ts +++ b/tests/type-checks/non-time-based-custom-series.ts @@ -1,4 +1,4 @@ -import { createChartEx, customSeriesDefaultOptions } from '../../src'; +import { createChartEx, customSeriesDefaultOptions, TextWatermark } from '../../src'; import { CandlestickData, WhitespaceData } from '../../src/model/data-consumer'; import { Time } from '../../src/model/horz-scale-behavior-time/types'; import { CustomData, CustomSeriesPricePlotValues, ICustomSeriesPaneRenderer, ICustomSeriesPaneView, PaneRendererCustomData } from '../../src/model/icustom-series'; @@ -106,3 +106,8 @@ if (dataSet) { // @ts-expect-error readonly array // eslint-disable-next-line @typescript-eslint/no-unsafe-call dataSet.push({ time: 12 }); + +const textWatermark = new TextWatermark({ + lines: [], +}); +chart.panes()[1].attachPrimitive(textWatermark); diff --git a/tests/type-checks/watermarks.ts b/tests/type-checks/watermarks.ts new file mode 100644 index 0000000000..2fe644860d --- /dev/null +++ b/tests/type-checks/watermarks.ts @@ -0,0 +1,28 @@ +import { createChart, ImageWatermark, TextWatermark } from '../../src'; + +const chart = createChart('anything'); + +const mainSeries = chart.addLineSeries(); +mainSeries.setData([]); + +const imageWatermark = new ImageWatermark('/debug/image.svg', { + alpha: 0.5, + padding: 50, + maxHeight: 400, + maxWidth: 400, +}); +chart.panes()[0].attachPrimitive(imageWatermark); + +const textWatermark = new TextWatermark({ + horzAlign: 'center', + vertAlign: 'center', + lines: [ + { + text: 'Hello', + color: 'rgba(255,0,0,0.5)', + fontSize: 100, + fontStyle: 'bold', + }, + ], +}); +chart.panes()[1].attachPrimitive(textWatermark); diff --git a/website/docs/migrations/from-v4-to-v5.md b/website/docs/migrations/from-v4-to-v5.md index 8b887a153b..573603f254 100644 --- a/website/docs/migrations/from-v4-to-v5.md +++ b/website/docs/migrations/from-v4-to-v5.md @@ -1,10 +1,80 @@ # From v4 to v5 -In this document you can find the migration guide from the previous version v4 to v5. +In this document you can find the migration guide from the previous version v4 +to v5. + +## Watermarks + +### Overview of Changes + +In the new version of Lightweight Charts, the watermark feature has undergone significant changes: + +1. **Extraction from Core**: The watermark functionality has been extracted from the core library. +2. **Re-implementation**: It's now re-implemented as a Pane Primitive (plugin) included within the library. +3. **Improved Tree-shaking**: This change makes the feature more tree-shakeable, potentially reducing bundle sizes for users who don't need watermarks. +4. **Added an Image Watermark Primitive**: In addition to the usual text based watermark, there is now +an image watermark feature provided by the [`ImageWatermark`](/api/classes/ImageWatermark.md) primitive. + +If you're currently using the watermark feature, you'll need to make a few adjustments to your code. + +### Accessing the New TextWatermark + +The TextWatermark primitive is now available as follows: + +- **ESM builds**: Import [`TextWatermark`](/api/classes/TextWatermark.md) directly. +- **Standalone script build**: Access via `LightweightCharts.TextWatermark`. + +### Changes in Options + +The options structure for watermarks has been revised: + +1. **Multiple Lines**: The plugin now supports multiple lines of text. +2. **Text Options**: Text-related options are now defined per line within the `lines` property of the options object. + +### Attaching the Watermark + +To use the Primitive, you need to attach it to a Pane: + +1. **Single Pane**: If you're using only one pane, you can easily fetch it using `chart.panes()[0]`. +2. **Multiple Panes**: For charts with multiple panes, you'll need to specify which pane to attach the watermark to. + +### Example: Implementing a Text Watermark + +Here's a comprehensive example demonstrating how to implement a text watermark in the new version: + +```js +const chart = createChart(container, options); +const mainSeries = chart.addLineSeries(); +mainSeries.setData(generateData()); + +const textWatermark = new TextWatermark({ + horzAlign: 'center', + vertAlign: 'center', + lines: [ + { + text: 'Hello', + color: 'rgba(255,0,0,0.5)', + fontSize: 100, + fontStyle: 'bold', + }, + { + text: 'This is a text watermark', + color: 'rgba(0,0,255,0.5)', + fontSize: 50, + fontStyle: 'italic', + fontFamily: 'monospace', + }, + ], +}); + +const firstPane = chart.panes()[0]; +firstPane.attachPrimitive(textWatermark); +``` ## Plugin Typings -Some of the plugin types and interfaces have been renamed due to the additional of Pane Primitives. +Some of the plugin types and interfaces have been renamed due to the additional +of Pane Primitives. - `ISeriesPrimitivePaneView` -> `IPrimitivePaneView` - `ISeriesPrimitivePaneRenderer` -> `IPrimitivePaneRenderer` diff --git a/website/tutorials/how_to/.eslintrc.js b/website/tutorials/how_to/.eslintrc.js index e5bae9c40c..379db16386 100644 --- a/website/tutorials/how_to/.eslintrc.js +++ b/website/tutorials/how_to/.eslintrc.js @@ -3,5 +3,7 @@ module.exports = { document: false, createChart: false, createChartEx: false, + TextWatermark: false, + ImageWatermark: false, }, }; diff --git a/website/tutorials/how_to/watermark-advanced.js b/website/tutorials/how_to/watermark-advanced.js index b709d35973..5ab395a50e 100644 --- a/website/tutorials/how_to/watermark-advanced.js +++ b/website/tutorials/how_to/watermark-advanced.js @@ -1,14 +1,12 @@ // remove-start -// Lightweight Charts™ Example: Watermark Advanced +// Lightweight Charts™ Example: Image Watermark // https://tradingview.github.io/lightweight-charts/tutorials/how_to/watermark // remove-end const chartOptions = { layout: { textColor: CHART_TEXT_COLOR, - // set chart background color to transparent so we can see the elements below - // highlight-next-line - background: { type: 'solid', color: 'transparent' }, + background: { type: 'solid', color: CHART_BACKGROUND_COLOR }, }, }; // remove-line @@ -16,18 +14,15 @@ const chartOptions = { const chart = createChart(document.getElementById('container'), chartOptions); // highlight-start -const container = document.getElementById('container'); -const background = document.createElement('div'); -// place below the chart -background.style.zIndex = -1; -background.style.position = 'absolute'; -// set size and position to match container -background.style.inset = '0px'; -background.style.backgroundImage = `url("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>")`; -background.style.backgroundRepeat = 'no-repeat'; -background.style.backgroundPosition = 'center'; -background.style.opacity = '0.5'; -container.appendChild(background); +// 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>'; +const imageWatermark = new ImageWatermark(imageDataUrl, { + alpha: 0.5, + padding: 20, +}); + +const firstPane = chart.panes()[0]; +firstPane.attachPrimitive(imageWatermark); // highlight-end const lineSeries = chart.addAreaSeries({ diff --git a/website/tutorials/how_to/watermark-simple.js b/website/tutorials/how_to/watermark-simple.js index a8bbd80fe7..73e09bfded 100644 --- a/website/tutorials/how_to/watermark-simple.js +++ b/website/tutorials/how_to/watermark-simple.js @@ -13,17 +13,22 @@ const chartOptions = { /** @type {import('lightweight-charts').IChartApi} */ const chart = createChart(document.getElementById('container'), chartOptions); +// remove-line +/** @type {import('lightweight-charts').TextWatermark} */ // highlight-start -chart.applyOptions({ - watermark: { - visible: true, - fontSize: 24, - horzAlign: 'center', - vertAlign: 'center', - color: 'rgba(171, 71, 188, 0.5)', - text: 'Watermark Example', - }, +const textWatermark = new TextWatermark({ + horzAlign: 'center', + vertAlign: 'center', + lines: [ + { + text: 'Watermark Example', + color: 'rgba(171, 71, 188, 0.5)', + fontSize: 24, + }, + ], }); +const firstPane = chart.panes()[0]; +firstPane.attachPrimitive(textWatermark); // highlight-end const lineSeries = chart.addAreaSeries({ diff --git a/website/tutorials/how_to/watermark.mdx b/website/tutorials/how_to/watermark.mdx index cda9d4f57d..6fe89b2a79 100644 --- a/website/tutorials/how_to/watermark.mdx +++ b/website/tutorials/how_to/watermark.mdx @@ -11,36 +11,41 @@ keywords: Lightweight Charts™ has a built-in feature for displaying simple text watermarks on your chart. This example shows how to configure and add this simple text watermark to your chart. -If you are looking to add a more complex watermark then have a look at the [advanced watermark example](#advanced-watermark-example) +If you are looking to add a more complex watermark then have a look at the [image watermark example](#image-watermark-example) included below. ## Short answer -A simple text watermark can be configured and added by specifying the [`watermark`](/docs/api/interfaces/ChartOptionsBase#watermark) property within -the chart options as follows: +A simple text watermark can be configured and added by using the [`TextWatermark`](/docs/next/api/classes/TextWatermark) pane primitive exported +from the library as follows: ```js -chart.applyOptions({ - watermark: { - visible: true, - fontSize: 24, - horzAlign: 'center', - vertAlign: 'center', - color: 'rgba(171, 71, 188, 0.5)', - text: 'Watermark Example', - }, +import { TextWatermark } from 'lightweight-charts'; + +const textWatermark = new TextWatermark({ + horzAlign: 'center', + vertAlign: 'center', + lines: [ + { + text: 'Watermark Example', + color: 'rgba(171, 71, 188, 0.5)', + fontSize: 24, + }, + ], }); -``` -The options available for the watermark are: [Watermark Options](/docs/api/interfaces/WatermarkOptions). +const firstPane = chart.panes()[0]; +firstPane.attachPrimitive(textWatermark); +``` -To have the watermark appear, you need to set `visible` to `true` and ensure that the `text` property isn't empty. +The options available for the watermark are: [TextWatermark Options](/docs/next/api/interfaces/TextWatermarkOptions). You can see full [working examples](#examples) below. ## Resources -- [Watermark Options](/docs/api/interfaces/WatermarkOptions) +- [`TextWatermark` pane primitive](/docs/next/api/classes/TextWatermark). +- [TextWatermark Options](/docs/next/api/interfaces/TextWatermarkOptions) ## Examples @@ -58,46 +63,38 @@ import codeSimple from "!!raw-loader!./watermark-simple.js"; {codeSimple} -### Advanced Watermark Example - -If a simple text watermark doesn't meet your requirements then you can use the following tips -to rather create your own custom watermark using `html` and `css`. +### Image Watermark Example -We will first set the `background` color of the chart to `transparent` so that we can -place our custom watermark underneath the chart and still see it. +If a simple text watermark doesn't meet your requirements then you can use the [`ImageWatermark`](/docs/next/api/classes/ImageWatermark) pane primitive exported +from the library as follows: ```js -chart.applyOptions({ - layout: { - // set chart background color to transparent so we can see the elements below - // highlight-next-line - background: { type: 'solid', color: 'transparent' }, - }, +import { ImageWatermark } from 'lightweight-charts'; + +const imageWatermark = new ImageWatermark('/images/my-image.png', { + alpha: 0.5, + padding: 20, }); + +const firstPane = chart.panes()[0]; +firstPane.attachPrimitive(imageWatermark); ``` -Next we will create a `div` element, and attach it as a child of the `container` element which is holding the chart. +The options available for the watermark are: [ImageWatermark Options](/docs/next/api/interfaces/ImageWatermarkOptions). -By setting the `zIndex` value for this div to be negative it will appear beneath the chart. +You can see full [working examples](#examples) below. -We will position the div using `display: absolute` and by setting `inset: 0px` the div will fill the container. +## Resources -You can then style the div to meet your specific needs. +- [`ImageWatermark` pane primitive](/docs/next/api/classes/ImageWatermark). +- [ImageWatermark Options](/docs/next/api/interfaces/ImageWatermarkOptions) -```js -const container = document.getElementById('container'); -const background = document.createElement('div'); -// place below the chart -background.style.zIndex = -1; -background.style.position = 'absolute'; -// set size and position to match container -background.style.inset = '0px'; -background.style.backgroundImage = `url("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>")`; -background.style.backgroundRepeat = 'no-repeat'; -background.style.backgroundPosition = 'center'; -background.style.opacity = '0.5'; -container.appendChild(background); -``` +:::tip + +Since the watermark image is black content with a transparent background, it may not be visible when +viewing the documentation site in dark mode. + +::: import codeAdvanced from "!!raw-loader!./watermark-advanced.js";