StockEventsSettings

23 Sep 20251 minute to read

Configures the Stock events for stock chart.

Properties

background string

The background of the stock event that accepts value in hex and rgba as a valid CSS color string.

Defaults to ‘transparent’

border StockChartBorderModel

Options to customize the border of the stock events.

date Date

Date value of stock event in which stock event shows.

description string

Specifies the description for the chart which renders in tooltip for stock event.

placeAt string

Corresponding values in which stock event placed.

  • Close
  • Open
  • High
  • Close

Defaults to ‘close’

seriesIndexes number[]

To render stock events in particular series.
By default stock events will render for all series.

Defaults to []

showOnSeries boolean

Enables the stock events to be render on series. If it disabled, stock event rendered on primaryXAxis.

Defaults to true

text string

Specifies the text for the stock chart text.

textStyle StockChartFontModel

Options to customize the styles for stock events text.

type FlagType

Specifies type of stock events

  • Circle
  • Square
  • Flag
  • Text
  • Sign
  • Triangle
  • InvertedTriangle
  • ArrowUp
  • ArrowDown
  • ArrowLeft
  • ArrowRight

Defaults to ‘Circle’