charton

Appearance

charton API

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

Interface: ChartSettingsHandle ​

Defined in: ui/src/chart-settings.ts:106

Returned by createChartSettings: opens or closes the settings dialog and reads the saved settings.

Properties ​

commandSource ​

readonly commandSource: CommandSource

Defined in: ui/src/chart-settings.ts:119

Command palette source (id settings) listing the dialog's sections; running one opens the dialog at it. The shell adds it to its palette.

dialog ​

readonly dialog: FormDialog | null

Defined in: ui/src/chart-settings.ts:112

isOpen ​

readonly isOpen: boolean

Defined in: ui/src/chart-settings.ts:111

values ​

readonly values: Readonly<Record<string, unknown>>

Defined in: ui/src/chart-settings.ts:114

The saved settings that are not appearance overrides, by option path.

Methods ​

close() ​

close(): void

Defined in: ui/src/chart-settings.ts:110

Cancel the open dialog: the chart goes back to how it was when the dialog opened.

Returns ​

void

destroy() ​

destroy(): void

Defined in: ui/src/chart-settings.ts:120

Returns ​

void

open() ​

open(section?): FormDialog | null

Defined in: ui/src/chart-settings.ts:108

Open the dialog, at section if given; the open one when it is already open. Null when no field applies.

Parameters ​

section? ​

string

Returns ​

FormDialog | null