Version: 1.0.0
Custom watermark
The CustomWatermark module controls the large background watermark text — shown over the chart canvas — with full control over visibility modes, colors, and content overrides.
Overview
Edit custom-watermark.js to call window.ChartingAPI.setWatermark(). By default the watermark auto-displays the active symbol, description, and resolution.
Settings API
window.ChartingAPI.setWatermark({
show: true,
watermarkMode: 'always', // 'always' | 'replay' | 'none'
showWatermarkTicker: true,
showWatermarkDescription: true,
showWatermarkInterval: true,
showWatermarkReplay: true,
symbol: 'BTC', // Force a specific symbol text
description: 'Bitcoin', // Force a specific description
interval: '30m', // Force a specific interval text
defaultSymbol: 'BTCUSD', // Fallback when no chart loaded
defaultDescription: 'Bitcoin / U.S. Dollar',
defaultInterval: '30m'
});
show: true,
watermarkMode: 'always', // 'always' | 'replay' | 'none'
showWatermarkTicker: true,
showWatermarkDescription: true,
showWatermarkInterval: true,
showWatermarkReplay: true,
symbol: 'BTC', // Force a specific symbol text
description: 'Bitcoin', // Force a specific description
interval: '30m', // Force a specific interval text
defaultSymbol: 'BTCUSD', // Fallback when no chart loaded
defaultDescription: 'Bitcoin / U.S. Dollar',
defaultInterval: '30m'
});
Options Reference
| Option | Type | Description |
|---|---|---|
| show | boolean | Master toggle for watermark visibility. |
| watermarkMode | 'always' | 'replay' | 'none' | When to display the watermark. |
| showWatermarkTicker | boolean | Show/hide symbol ticker text. |
| showWatermarkInterval | boolean | Show/hide interval text. |
| symbol | string | Force a specific symbol text override. |
| defaultSymbol | string | Fallback symbol when no chart is loaded. |