charton API / @chart-on/ui / index / ShellEvents
Interface: ShellEvents
Defined in: ui/src/shell.ts:278
Events emitted by a chart shell, by name: theme, palette and color preset changes, and the rail or toolbar being shown or hidden.
Properties
palette:change
palette:change:
object
Defined in: ui/src/shell.ts:286
setPalette switched the up and down colours.
palette
palette:
ShellPalette
preset:change
preset:change:
object
Defined in: ui/src/shell.ts:292
The colour preset changed: picked in the appearance panel or set with setColorPreset. preset is its id, null for the default theme. A theme switch keeps the preset and emits theme:change instead.
preset
preset:
string|null
rail:change
rail:change:
object
Defined in: ui/src/shell.ts:294
The rail was shown or hidden. Read the current state from shell.rail.visible.
visible
visible:
boolean
theme:change
theme:change:
object
Defined in: ui/src/shell.ts:284
setTheme changed the theme, the OS scheme changed while the theme is system, forced colours (an OS high-contrast mode) turned on or off, or a re-read of the CSS chart tokens (see refreshTheme) changed the chart colours.
resolved
resolved:
"dark"|"light"
theme
theme:
ShellTheme
toolbar:change
toolbar:change:
object
Defined in: ui/src/shell.ts:296
The toolbar was shown or hidden. Read the current state from shell.toolbar.visible.
visible
visible:
boolean