Interface Widget

interface Widget {
    chart: Chart;
    context: WidgetContext;
    dataController: null | DataLoadingController;
    draw: DrawingController;
    isDestroyed: boolean;
    objects: ChartObjects;
    root: HTMLElement;
    series: SeriesApi;
    chartType(): string;
    destroy(): void;
    exchange(): string;
    getState(): WidgetState;
    interval(): string;
    off<K extends WidgetEventName>(
        event: K,
        cb?: (payload: WidgetBusEvents[K]) => void,
    ): void;
    on<K extends WidgetEventName>(
        event: K,
        cb: (payload: WidgetBusEvents[K]) => void,
    ): () => void;
    openIndicatorPicker(): boolean;
    openObjects(): boolean;
    openSettings(): boolean;
    reload(): Promise<void>;
    restoreState(state: unknown): WidgetRestoreReport;
    setChartType(id: string): void;
    setInterval(code: string): void;
    setSymbol(symbol: string, exchange?: string): void;
    setTheme(theme: ChartTheme | WidgetThemeName): void;
    symbol(): string;
    theme(): WidgetThemeName;
}

Properties

chart context dataController draw isDestroyed objects root series

Methods

chartType destroy exchange getState interval off on openIndicatorPicker openObjects openSettings reload restoreState setChartType setInterval setSymbol setTheme symbol theme

Properties

Readonlychart

chart: Chart

Readonlycontext

context: WidgetContext

What every mounted piece was handed; a host mounting its own panel wants the same.

ReadonlydataController

dataController: null | DataLoadingController

Managed data owner, or null when the host supplies series data directly.

Readonlydraw

draw: DrawingController

ReadonlyisDestroyed

isDestroyed: boolean

Readonlyobjects

objects: ChartObjects

Shared inventory and supported actions for drawings, indicators and registered profiles.

Readonlyroot

root: HTMLElement

The .oac-widget element.

Readonlyseries

series: SeriesApi

The primary series, replaced by setChartType.

Methods

chartType

destroy

exchange

getState

interval

off

on

openIndicatorPicker

openObjects

  • openObjects(): boolean

  • Open the searchable object inventory. False after destruction.

    Returns boolean

openSettings

  • openSettings(): boolean

  • Open the settings dialog. False when the dialog tier has not registered one.

    Returns boolean

reload

  • reload(): Promise<void>

  • Load (or reload) bars from the feed for the current symbol and interval.

    Returns Promise<void>

restoreState

setChartType

setInterval

setSymbol

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

  • Parameters

    • symbol: string
    • Optionalexchange: string

    Returns void

setTheme

symbol

theme

Settings

Member Visibility

On This Page

Properties
Methods