Interface ReplayGroupChartHost

Chart implements this; headless hosts may supply the lifecycle hooks too.

interface ReplayGroupChartHost {
    isDestroyed?: boolean;
    timeScale: ReplayViewport;
    emit(event: string, payload: unknown): void;
    on(event: "destroy", callback: () => void): () => void;
    primarySeries(): null | SeriesApi;
}

Hierarchy (View Summary)

Properties

isDestroyed? timeScale

Methods

emit on? primarySeries?

Properties

Optional ReadonlyisDestroyed

isDestroyed?: boolean

ReadonlytimeScale

timeScale: ReplayViewport

Methods

emit

Optionalon

  • on(event: "destroy", callback: () => void): () => void

  • Optional. When the chart reports its own end, replay listens for it while it owns the chart's data: a chart destroyed mid-session stops the playback timer and is written to no more, and nothing is restored to it.

    Parameters

    • event: "destroy"
    • callback: () => void

    Returns () => void

OptionalprimarySeries

Settings

Member Visibility

On This Page

Properties
Methods