Kumo Charts

@kumo-charts/core/watermark

API 参考由源码注释生成,只有英文。

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

Functions

watermarkfunction源码

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

WatermarkLineinterface源码

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.

WatermarkOptionsinterface源码

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

WatermarkModuletype源码

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

↑↓ 选择 · Enter 打开 · Esc 关闭