Interface BottombarOptions

interface BottombarOptions {
    now?: () => number;
    ranges?: readonly WidgetRange[];
    target?: () => null | BottombarTarget;
    timezones?: readonly string[];
    onGoTo(anchor: HTMLElement): boolean | void;
    onTimezone(zone: string): void;
}

Properties

now? ranges? target? timezones?

Methods

onGoTo? onTimezone?

Properties

Optionalnow

now?: () => number

Clock for the time and the market status, in milliseconds. Default Date.now.

Optionalranges

ranges?: readonly WidgetRange[]

The range buttons. [] leaves them out. Default DEFAULT_RANGES.

Optionaltarget

target?: () => null | BottombarTarget

What the bar acts on, read at every use: a grid passes its focused chart. Default: the context's chart, with no ranges.

Optionaltimezones

timezones?: readonly string[]

Zones the timezone menu lists first. Default: those the settings dialog offers.

Methods

OptionalonGoTo

  • onGoTo(anchor: HTMLElement): boolean | void

  • Open the go-to panel from the bar's button. Omit to leave the button out.

    Parameters

    • anchor: HTMLElement

    Returns boolean | void

OptionalonTimezone

  • onTimezone(zone: string): void

  • Called after the bar moves the chart to another zone, for a host that keeps its own copy.

    Parameters

    • zone: string

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods