Skip to main content

Interface: TimescaleMark

Charting Library.TimescaleMark

Properties​

color​

color: string

Color for the timescale mark

customTooltip​

Optional

customTooltip: string

Trading Platform only. Optional content for a custom tooltip rendered by your own tv-custom-timescale-mark custom element instead of the default tooltip body. The value is an opaque payload — typically a JSON string — that the library sets as the element's text content. It is never parsed as HTML by the library.

Register the element by loading a module via the custom_js_urls widget constructor option or the addCustomJSFile widget method. If the element is not registered, the default tooltip rendering is used instead. See the Customize mark tooltips guide for more information.

id​

id: string | number

ID of the timescale mark

imageUrl​

Optional

imageUrl: string

Optional URL for an image to be displayed within the timescale mark.

The image should ideally be square in dimension. You can use any image type which the browser supports natively.

Example

- `https://s3-symbol-logo.tradingview.com/crypto/XTVCBTC.svg`
- `/images/myImage.png`
- `data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3...`
- `data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAASABIAAD/4...`

label​

label: string

Label for the timescale mark

labelFontColor​

Optional

labelFontColor: string

Color for the timescale mark text label. If undefined then the value provided for color will be used.

shape​

Optional

shape: TimeScaleMarkShape

Shape of the timescale mark

showLabelWhenImageLoaded​

Optional

showLabelWhenImageLoaded: boolean

Continue to show text label even when an image has been loaded for the timescale mark.

Defaults to false if undefined.

time​

time: number

Time for the mark. Unix timestamp in seconds.

tooltip​

tooltip: string[]

Tooltip content