Interface ReplayChartHost

The slice of the chart this controller needs. Chart satisfies it; declaring it structurally keeps the controller testable against a stub and free of a circular import back into core.

interface ReplayChartHost {
    timeScale: ReplayViewport;
    emit(event: string, payload: unknown): void;
    primarySeries(): null | SeriesApi;
}

Index

Properties

Methods

emit primarySeries?

Properties

`Readonly`timeScale

timeScale: ReplayViewport

Methods

emit

emit(event: string, payload: unknown): void
Parameters
- event: string
- payload: unknown
Returns void
- Defined in src/replay/controller.ts:55

`Optional`primarySeries

primarySeries(): null | SeriesApi
Optional. When the chart can name its own primary price series, series may be omitted and replay drives that one.

Returns null | SeriesApi
- Defined in src/replay/controller.ts:61