charton

Appearance

charton API

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

Interface: IndicatorPickerHandle ​

Defined in: ui/src/indicator-picker.ts:127

The indicator picker dialog: open and close it, read and change the recents and favourites.

Properties ​

commandSource ​

readonly commandSource: CommandSource

Defined in: ui/src/indicator-picker.ts:147

Command palette source (id indicators) listing the picker's catalogue; running an entry adds the indicator as a picker row does. The shell adds it to its palette: palette.addSource(picker.commandSource).

el ​

el: HTMLElement

Defined in: ui/src/indicator-picker.ts:129

Backdrop that holds the dialog; hidden while closed.

favorites ​

readonly favorites: readonly string[]

Defined in: ui/src/indicator-picker.ts:139

Starred definition ids.

isOpen ​

readonly isOpen: boolean

Defined in: ui/src/indicator-picker.ts:130

recents ​

readonly recents: readonly string[]

Defined in: ui/src/indicator-picker.ts:137

Definition ids, most recently added first.

Methods ​

close() ​

close(): void

Defined in: ui/src/indicator-picker.ts:134

Close and return focus to where it was before opening.

Returns ​

void

destroy() ​

destroy(): void

Defined in: ui/src/indicator-picker.ts:148

Returns ​

void

open() ​

open(query?): void

Defined in: ui/src/indicator-picker.ts:132

Open on the All tab with query in the search box (empty by default).

Parameters ​

query? ​

string

Returns ​

void

toggle() ​

toggle(): void

Defined in: ui/src/indicator-picker.ts:135

Returns ​

void

toggleFavorite() ​

toggleFavorite(id): void

Defined in: ui/src/indicator-picker.ts:141

Star or unstar a definition.

Parameters ​

id ​

string

Returns ​

void