Interface ComparisonChartHost

The slice of the chart this controller needs. Chart satisfies it; declaring it structurally keeps the controller testable against a stub.

interface ComparisonChartHost {
    dataLayer: {
        length: number;
        indexToTime(index: number): undefined | number;
    };
    addPrimitive(primitive: IPrimitive, paneIndex?: number): void;
    addSeries(type: SeriesType, options: AddSeriesOptions): SeriesApi;
    getVisibleLogicalRange(): { from: number; to: number };
    on(event: string, callback: (payload: unknown) => void): () => void;
    panes(): readonly ComparisonPane[];
    primaryBars(): readonly Bar[];
    primaryPaneIndex(): number;
    primarySeries(): null | SeriesApi;
    removePrimitive(primitive: IPrimitive): void;
}

Properties

dataLayer

Methods

addPrimitive addSeries getVisibleLogicalRange? on? panes primaryBars? primaryPaneIndex? primarySeries removePrimitive

Properties

ReadonlydataLayer

dataLayer: { length: number; indexToTime(index: number): undefined | number }

The shared logical axis locates visible primary bars even when another series adds times.

Methods

addPrimitive

addSeries

OptionalgetVisibleLogicalRange

Optionalon

  • on(event: string, callback: (payload: unknown) => void): () => void

  • Parameters

    • event: string
    • callback: (payload: unknown) => void

    Returns () => void

panes

OptionalprimaryBars

OptionalprimaryPaneIndex

  • primaryPaneIndex(): number

  • Slot of the price pane, the default target. Absent means slot 0.

    Returns number

primarySeries

removePrimitive

Settings

Member Visibility

On This Page

Properties
Methods