Interface OHLCSeriesOptions<PositiveFigure, NegativeFigure, OHLCSeriesType>

Interface can be used to define the X and Y Axis that a series should be attached to, type of OHLCFigure used for positive segments, negative segments and series.

Type Parameters

  • PositiveFigure extends OHLCFigure

  • NegativeFigure extends OHLCFigure

  • OHLCSeriesType extends OHLCSeriesTypesUnion<PositiveFigure, NegativeFigure>

Hierarchy

Properties

automaticColorIndex?: number

Optional index to use for automatic coloring of series.

Normally series are automatically colored differently when you create several series in the same chart. However, in some cases you might want to alter this order of automatic coloring, or use the automatic color palettes on series that belong to different charts.

In these scenarios you can use automaticColorIndex to tell each series individually what is its place in the default color palette.

 // Create series using the first color in default Theme palette.
const series1 = chart.addLineSeries({ automaticColorIndex: 0 })
// Create another series colored with the 3rd color.
const series2 = chart.addLineSeries({ automaticColorIndex: 2 })
negativeFigure?: OHLCFigureConstructor<NegativeFigure>

Type of OHLCFigure used for negative segments.

positiveFigure?: OHLCFigureConstructor<PositiveFigure>

Type of OHLCFigure used for positive segments.

seriesConstructor?: OHLCSeriesConstructor<PositiveFigure, NegativeFigure, OHLCSeriesType>

Type of OHLCSeries created.

xAxis?: Axis

Optional non-default X Axis to attach series to.

By default, series are attached to the same X Axis, that is returned by getDefaultAxisX.

yAxis?: Axis

Optional non-default Y Axis to attach series to.

By default, series are attached to the same Y Axis, that is returned by getDefaultAxisY.