Kumo Charts

@kumo-charts/core/watermark

The API reference is generated from the source comments.

import { … } from '@kumo-charts/core/watermark';

Functions

watermarkfunctionSource

function watermark(): WatermarkModule

The watermark module: large faint text in the middle of the main pane, under the series, such as the symbol and its timeframe, set by the watermark option:

const chart = createChart(container, {
  modules: [watermark()],
  watermark: { lines: [{ text: 'BTCUSDT' }, { text: '1h', size: 20 }] }
});

Interfaces

WatermarkLineinterfaceSource

interface WatermarkLine

A line of text of the watermark.

readonly text: string
readonly size?: number

Font size in CSS pixels, from 6 to 200. Default 40.

WatermarkOptionsinterfaceSource

interface WatermarkOptions

The watermark section of the chart's options, which the watermark module adds.

lines: readonly WatermarkLine[]

Lines of text in the middle of the main pane, under the series, such as the symbol and its timeframe, from the top down. None by default.

color: string | null

The color of the text; null (default) takes the theme's text color, faint.

Types

WatermarkModuletypeSource

type WatermarkModule = ChartModule<{
  readonly options: { readonly watermark: WatermarkOptions };
}>

↑↓ to select · Enter to open · Esc to close