Skip to main content
Version: v26

TimescaleMark

Interface

Properties

color

Color for the timescale mark

Type

string


id

ID of the timescale mark

Type

string | number


imageUrl

Optional

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.

Examples:

  • 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...

Type

string


label

Label for the timescale mark

Type

string


labelFontColor

Optional

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

Type

string


shape

Optional

Shape of the timescale mark

Type

TimeScaleMarkShape


showLabelWhenImageLoaded

Optional

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

Defaults to false if undefined.

Type

boolean


time

Time for the mark. Amount of milliseconds since Unix epoch start in UTC timezone.

Type

number


tooltip

Tooltip content

Type

string[]