Interface DateNavigatorOptions

interface DateNavigatorOptions {
    chart: Chart | () => null | Chart;
    interval(): undefined | string;
    loadHistory(time: number, signal: AbortSignal): Promise<HistoryReach>;
}

Properties

chart

Methods

interval? loadHistory?

Properties

chart

chart: Chart | () => null | Chart

The chart to place. A function is read again after every load, for a host that rebuilds its chart.

Methods

Optionalinterval

  • interval(): undefined | string

  • Interval code of the primary bars. Default: the chart's data context.

    Returns undefined | string

OptionalloadHistory

  • loadHistory(time: number, signal: AbortSignal): Promise<HistoryReach>

  • Prepend older primary bars reaching back to time, resolving once they are on the chart. Called again while it adds bars and time is not yet reached. Omit to navigate loaded history only.

    Parameters

    • time: number
    • signal: AbortSignal

    Returns Promise<HistoryReach>

Settings

Member Visibility

On This Page

Properties
Methods