Interface BottombarContext

What the bar needs from its host: a document, an overlay stack and tips for its menus and labels, a status line for what a range did, and translations. A WidgetContext is one; a custom host builds one from createOverlayStack and createTipController over an .oac-widget root.

interface BottombarContext {
    chart?: Chart;
    document: Document;
    locale?: string;
    tips: TipController;
    translate?: WidgetTranslator;
    openOverlay(el: HTMLElement, opts?: OverlayOptions): () => void;
    status(text: string, kind?: "error" | "info"): void;
}

Hierarchy (View Summary)

Properties

chart? document locale? tips translate?

Methods

openOverlay status

Properties

Optional Readonlychart

chart?: Chart

The chart the bar acts on when BottombarOptions.target is not given.

Readonlydocument

document: Document

Optional Readonlylocale

locale?: string

BCP 47 tag for weekday names. Default: the runtime's.

Readonlytips

tips: TipController

Optionaltranslate

translate?: WidgetTranslator

Translates widget-owned text. Omit to preserve English rendering.

Methods

openOverlay

status

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

  • Report what a control did, and why a range fell short.

    Parameters

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

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods