Skip to content

Latest commit

 

History

History
30 lines (17 loc) · 1.68 KB

Marks.md

File metadata and controls

30 lines (17 loc) · 1.68 KB

The Charting Library supports the display of marks on bars and on the timescale. Marks are requested from your back-end if it supports them. Marks are designed to give you an ability to show events attached to bars/timescale. Here are a few examples:

  • News
  • Bar patterns
  • Splits/Dividends
  • .. etc.

You can subscribe to mark events using subscribe(event, callback) Widget Method. Also, there are Chart Methods to refresh marks and clear marks.

Marks on bars

Marks on bars are colored circles with custom size and color with a letter inside. One bar can have a few marks. When user clicks on a mark, the tooltip appears. The tooltip can contain an HTML-code or a plain text.

Example:

images/tv_bar_mark.png

Marks on bars are requested by the library for the visible data range using getMarks() JS API method and /marks UDF request.

Marks on the timescale

Marks on the timescale are basically lolipops above the timescale. Each mark has custom letter inside and the popup tooltip with one or two info strings.

Marks are requested from your back-end if it supports them.

Example:

images/tv_timescale_mark.png

Marks on the timescale are requested by the library for the visible data range using getTimescaleMarks() JS API method and /timescale_marks UDF request.