charton

Appearance

charton API

charton API / @chart-on/ui / index / IndicatorSettingsOptions

Interface: IndicatorSettingsOptions ​

Defined in: ui/src/indicator-settings.ts:267

Options for openIndicatorSettings: what happens when the user switches to another indicator from the panel's header, and a control for the header.

Properties ​

headerControl? ​

optional headerControl?: (context) => { el: HTMLElement; destroy: void; } | null

Defined in: ui/src/indicator-settings.ts:279

A control for the panel's header, made when the panel opens and destroyed when it closes; null for none. The template menu of @chart-on/ui/templates (indicatorTemplates()) is one.

Parameters ​

context ​

IndicatorSettingsContext

Returns ​

{ el: HTMLElement; destroy: void; } | null

Methods ​

onSwitch()? ​

optional onSwitch(indicator): void

Defined in: ui/src/indicator-settings.ts:273

Called when the user picks another indicator in the header's switcher, after the open panel kept its edits and closed. Default: open that indicator's settings in the same host.

Parameters ​

indicator ​

Indicator

Returns ​

void