Interface SettingsDialogOptions

interface SettingsDialogOptions {
    tab?: ChartSettingsTabId;
    onApply(patch: Readonly<Partial<ChartSettingsValues>>): void;
    onClose(committed: boolean): void;
    unavailable(key: string, option?: string): null | string;
}

Properties

The tab to open on. Default: the first tab with a control in it.

Methods

  • Runs once when the dialog is gone; committed is false after Cancel or Escape.

    Parameters

    • committed: boolean

    Returns void

  • Why a control, or one option of a select, cannot act in this host right now, or null. A host that draws its own trade chrome knows whether there is a position to recolour; the engine does not.

    Parameters

    • key: string
    • Optionaloption: string

    Returns null | string