Interface WidgetContext

interface WidgetContext {
    bus: WidgetBus<WidgetBusEvents>;
    chart: Chart;
    chartTheme: ChartTheme;
    document: Document;
    draw: DrawingController;
    keymap: Keymap;
    locale: undefined | string;
    objects?: ChartObjects;
    overlays: OverlayStack;
    root: HTMLElement;
    storage: WidgetStorage;
    theme: WidgetThemeName;
    tips: TipController;
    interval(): string;
    openOverlay(el: HTMLElement, opts?: OverlayOptions): () => void;
    status(text: string, kind?: "error" | "info"): void;
    symbol(): { exchange: string; symbol: string };
    toast(message: string, kind?: ToastKind): ToastHandle;
}

Properties

bus chart chartTheme document draw keymap locale objects? overlays root storage theme tips

Methods

interval openOverlay status symbol toast

Properties

Readonlybus

bus: WidgetBus<WidgetBusEvents>

Readonlychart

chart: Chart

ReadonlychartTheme

chartTheme: ChartTheme

The engine palette the chart is drawing with.

Readonlydocument

document: Document

Readonlydraw

draw: DrawingController

Readonlykeymap

keymap: Keymap

Readonlylocale

locale: undefined | string

Optional Readonlyobjects

objects?: ChartObjects

Live inventory owned by the widget, optional for custom contexts.

Readonlyoverlays

overlays: OverlayStack

The overlay stack behind openOverlay, for a module that needs to ask what is open.

Readonlyroot

root: HTMLElement

The .oac-widget element every piece of chrome lives in.

Readonlystorage

storage: WidgetStorage

Per-widget persisted preferences; enabled is false when persist is off.

Readonlytheme

theme: WidgetThemeName

dark or light, following the chart theme in force.

Readonlytips

tips: TipController

Hover labels for controls.

Methods

interval

openOverlay

  • openOverlay(el: HTMLElement, opts?: OverlayOptions): () => void

  • Show el over the widget: positioned from opts.anchor (or centred as a dialog), focus-trapped, closed by Escape and by a press outside. Returns the closer.

    Parameters

    Returns () => void

status

  • status(text: string, kind?: "error" | "info"): void

  • Put a transient message on the status line.

    Parameters

    • text: string
    • Optionalkind: "error" | "info"

    Returns void

symbol

  • symbol(): { exchange: string; symbol: string }

  • The current symbol and interval, for dialogs that name them.

    Returns { exchange: string; symbol: string }

toast

Settings

Member Visibility

On This Page

Properties
Methods