Interface ComparisonOptions

interface ComparisonOptions {
    bars: readonly SeriesDataItem[];
    color?: string;
    paneIndex?: number;
    style?: SeriesStyle;
    symbol: string;
    type?: SeriesType;
}

Index

Properties

bars color? paneIndex? style? symbol type?

Properties

bars

bars: readonly SeriesDataItem[]

The instrument's own bars. Aligned to the primary series, see ./align.

`Optional`color

color?: string

Line colour shorthand; style.color wins if both are given.

`Optional`paneIndex

paneIndex?: number

Pane to draw on. Default 0, the price pane.

`Optional`style

style?: SeriesStyle

Style overrides merged onto the chart type's defaults.

symbol

symbol: string

Instrument label, e.g. 'BANKNIFTY'. Carried on the handle for the host's UI.

`Optional`type

type?: SeriesType

Renderer for the comparison. Default 'line'.