Interface MobileOptions

interface MobileOptions {
    bottombar?: BottombarControls;
    canSelectInterval?: (code: string) => boolean;
    container: HTMLElement;
    indicators: boolean;
    intervals: readonly string[];
    mode?: MobileMode;
    rail: null | RailHandle;
    search?: SymbolSearch;
    timeframePreferences?: TimeframePreferences;
    tools?: readonly string[];
    topbar: boolean;
    indicatorsAvailable(): boolean;
    onAlerts(anchor: HTMLElement): boolean;
    onCapture(anchor: HTMLElement): void;
    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;
    onProperties(anchor: HTMLElement): boolean;
    onSettings(anchor: HTMLElement): boolean;
    onSymbol(symbol: string, exchange?: string): void;
    onTheme(): void;
    onWatchlist(anchor: HTMLElement): boolean | void;
    settingsAvailable(): boolean;
    state(): TopbarState;
}

Properties

bottombar? canSelectInterval? container indicators intervals mode? rail search? timeframePreferences? tools? topbar

Methods

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

Properties

Optionalbottombar

bottombar?: BottombarControls

The bottom bar's controls. The phone layout hides the bar, so the More sheet lists them instead: the market status and the clock, the preset ranges, the price scale toggles and the timezone.

OptionalcanSelectInterval

canSelectInterval?: (code: string) => boolean

container

container: HTMLElement

indicators

indicators: boolean

intervals

intervals: readonly string[]

Optionalmode

mode?: MobileMode

rail

rail: null | RailHandle

Optionalsearch

search?: SymbolSearch

OptionaltimeframePreferences

timeframePreferences?: TimeframePreferences

Optionaltools

tools?: readonly string[]

topbar

topbar: boolean

Methods

indicatorsAvailable

OptionalonAlerts

  • onAlerts(anchor: HTMLElement): boolean

  • Parameters

    • anchor: HTMLElement

    Returns boolean

OptionalonCapture

onChartType

OptionalonDataWindow

  • onDataWindow(anchor: HTMLElement): boolean | void

  • Parameters

    • anchor: HTMLElement

    Returns boolean | void

OptionalonGoTo

  • onGoTo(anchor: HTMLElement): boolean | void

  • 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, centred. Omitted without a store. Since 2.5.10.

    Parameters

    • anchor: HTMLElement

    Returns boolean | void

OptionalonNews

  • onNews(anchor: HTMLElement): boolean | void

  • Parameters

    • anchor: HTMLElement

    Returns boolean | void

onObjects

  • onObjects(anchor: HTMLElement): boolean

  • Parameters

    • anchor: HTMLElement

    Returns boolean

onProperties

  • onProperties(anchor: HTMLElement): boolean

  • Parameters

    • anchor: HTMLElement

    Returns boolean

onSettings

  • onSettings(anchor: HTMLElement): boolean

  • 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

  • Parameters

    • anchor: HTMLElement

    Returns boolean | void

settingsAvailable

state

Settings

Member Visibility

On This Page

Properties
Methods