Interface TopbarOptions

interface TopbarOptions {
    canSelectInterval?: (code: string) => boolean;
    captureRows?: () => readonly (string | MenuRow)[];
    indicators?: boolean;
    intervals: readonly string[];
    layouts?: LayoutsController;
    search?: SymbolSearch;
    state: () => TopbarState;
    timeframePreferences?: TimeframePreferences;
    dataAvailable(): boolean;
    indicatorsAvailable(): boolean;
    onAlerts(anchor: HTMLElement): boolean;
    onChartType(id: string): void;
    onDataWindow(anchor: HTMLElement): boolean | void;
    onGoTo(anchor: HTMLElement): boolean | void;
    onIndicators(anchor: HTMLElement): boolean;
    onInterval(code: string): void;
    onLayouts(anchor: HTMLElement): boolean | void;
    onNews(anchor: HTMLElement): boolean | void;
    onObjects(anchor: HTMLElement): boolean;
    onSettings(anchor: HTMLElement): boolean;
    onSymbol(symbol: string, exchange?: string): void;
    onTheme(next: WidgetThemeName): void;
    onWatchlist(anchor: HTMLElement): boolean | void;
    settingsAvailable(): boolean;
}

Properties

canSelectInterval? captureRows? indicators? intervals layouts? search? state timeframePreferences?

Methods

dataAvailable? indicatorsAvailable onAlerts? onChartType onDataWindow? onGoTo? onIndicators onInterval onLayouts? onNews? onObjects? onSettings onSymbol onTheme onWatchlist? settingsAvailable

Properties

OptionalcanSelectInterval

canSelectInterval?: (code: string) => boolean

OptionalcaptureRows

captureRows?: () => readonly (string | MenuRow)[]

More capture menu rows, read on every open (the chart grid adds its whole-grid capture); a string starts a group.

Optionalindicators

indicators?: boolean

Show the indicators button. Default true.

intervals

intervals: readonly string[]

Optionallayouts

layouts?: LayoutsController

The saved layouts the Layouts button names: it shows the held layout and marks one with unsaved changes. Omitted, with onLayouts, without a store.

Optionalsearch

search?: SymbolSearch

state

state: () => TopbarState

The current facts, read on every refresh.

OptionaltimeframePreferences

timeframePreferences?: TimeframePreferences

Methods

OptionaldataAvailable

  • dataAvailable(): boolean

  • Refuse CSV export while the host is replacing or recovering its data.

    Returns boolean

indicatorsAvailable

OptionalonAlerts

onChartType

OptionalonDataWindow

  • onDataWindow(anchor: HTMLElement): boolean | void

  • Open the docked data window, omitted without a handler.

    Parameters

    • anchor: HTMLElement

    Returns boolean | void

OptionalonGoTo

  • onGoTo(anchor: HTMLElement): boolean | void

  • Open the date and range navigation panel, omitted without a handler.

    Parameters

    • anchor: HTMLElement

    Returns boolean | void

onIndicators

  • onIndicators(anchor: HTMLElement): boolean

  • Parameters

    • anchor: HTMLElement

    Returns boolean

onInterval

OptionalonLayouts

  • onLayouts(anchor: HTMLElement): boolean | void

  • Open the Layouts menu from anchor.

    Parameters

    • anchor: HTMLElement

    Returns boolean | void

OptionalonNews

  • onNews(anchor: HTMLElement): boolean | void

  • Open the docked news reader, omitted without a handler (the host supplied no news source).

    Parameters

    • anchor: HTMLElement

    Returns boolean | void

OptionalonObjects

  • onObjects(anchor: HTMLElement): boolean

  • A text control for the host's object inventory, omitted without a handler.

    Parameters

    • anchor: HTMLElement

    Returns boolean

onSettings

  • onSettings(anchor: HTMLElement): boolean

  • Open the settings dialog from anchor. Return false when no dialog is registered.

    Parameters

    • anchor: HTMLElement

    Returns boolean

onSymbol

  • onSymbol(symbol: string, exchange?: string): void

  • Parameters

    • symbol: string
    • Optionalexchange: string

    Returns void

onTheme

OptionalonWatchlist

  • onWatchlist(anchor: HTMLElement): boolean | void

  • Open the docked watchlist, omitted without a handler (the host supplied no lists).

    Parameters

    • anchor: HTMLElement

    Returns boolean | void

settingsAvailable

Settings

Member Visibility

On This Page

Properties
Methods