Interface TopbarOptions

interface TopbarOptions {
    indicators?: boolean;
    intervals: readonly string[];
    search?: SymbolSearch;
    state: () => TopbarState;
    indicatorsAvailable(): boolean;
    onChartType(id: string): void;
    onIndicators(anchor: HTMLElement): boolean;
    onInterval(code: string): void;
    onObjects(anchor: HTMLElement): boolean;
    onSettings(anchor: HTMLElement): boolean;
    onSymbol(symbol: string, exchange?: string): void;
    onTheme(next: WidgetThemeName): void;
    settingsAvailable(): boolean;
}

Properties

indicators? intervals search? state

Methods

indicatorsAvailable onChartType onIndicators onInterval onObjects? onSettings onSymbol onTheme settingsAvailable

Properties

Optionalindicators

indicators?: boolean

Show the indicators button. Default true.

intervals

intervals: readonly string[]

Optionalsearch

search?: SymbolSearch

state

state: () => TopbarState

The current facts, read on every refresh.

Methods

indicatorsAvailable

onChartType

onIndicators

  • onIndicators(anchor: HTMLElement): boolean

  • Parameters

    • anchor: HTMLElement

    Returns boolean

onInterval

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

settingsAvailable

Settings

Member Visibility

On This Page

Properties
Methods