Skip to main content
Version: v26

Marks

Marks allow you to display some extra information like news, bar patterns, splits/dividends, and more on the chart or timescale.

Use the subscribe method to handle events raised when users interact with marks. You can also refresh and clear marks using the chart methods.

Marks on the Chart​

Marks on the chart are circles that are attached to bars and contain a character inside. You can customize the circle size and color. If you want to display two characters (like 'ED', 'AB', 'CD', etc.), you should enable the two_character_bar_marks_labels featureset.

One bar can have several marks. When a user clicks on the mark, the tooltip appears. The tooltip can only contain plain text. HTML code is not supported.

Marks

Marks are requested from your datafeed if you set supports_marks to true. The library calls getMarks or requests /marks to get mark data for the visible data range.

Marks on the Timescale​

Marks on the timescale are figures above the timescale. Each mark has a character inside and a pop-up tooltip with information strings. The tooltip does not support HTML code. You can specify a timescale mark shape using the shape property. Images can be displayed within timescale marks by providing an image url in the imageUrl property.

Timescale marks

Timescale marks are requested from your datafeed if you set supports_timescale_marks to true. The library calls getTimescaleMarks or requests /timescale_marks to get mark data for the visible data range.