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 };
    addPrimitive(primitive: IPrimitive, paneIndex?: number): void;
    addSeries(type: SeriesType, options: AddSeriesOptions): SeriesApi;
    panes(): readonly ComparisonPane[];
    primarySeries(): null | SeriesApi;
    removePrimitive(primitive: IPrimitive): void;
}

Index

Properties

Methods

addPrimitive addSeries panes primarySeries removePrimitive

Properties

`Readonly`dataLayer

dataLayer: { length: number }

Only length is read: it changes exactly when the shared time axis does.

Methods

addPrimitive

addPrimitive(primitive: IPrimitive, paneIndex?: number): void
Parameters
- primitive: IPrimitive
- OptionalpaneIndex: number
Returns void
- Defined in src/compare/controller.ts:112

addSeries

addSeries(type: SeriesType, options: AddSeriesOptions): SeriesApi
Parameters
- type: SeriesType
- options: AddSeriesOptions
Returns SeriesApi
- Defined in src/compare/controller.ts:110

panes

panes(): readonly ComparisonPane[]
Returns readonly ComparisonPane[]
- Defined in src/compare/controller.ts:111

primarySeries

primarySeries(): null | SeriesApi
Returns null | SeriesApi
- Defined in src/compare/controller.ts:114

removePrimitive

removePrimitive(primitive: IPrimitive): void
Parameters
- primitive: IPrimitive
Returns void
- Defined in src/compare/controller.ts:113