Skip to content

charton API


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

Interface: FavoritesBarState ​

Defined in: ui/src/favorites-model.ts:11

Where the favourites bar sits and whether the user wants it shown.

Properties ​

orientation ​

orientation: FavoritesBarOrientation

Defined in: ui/src/favorites-model.ts:14


visible ​

visible: boolean

Defined in: ui/src/favorites-model.ts:13

The user's choice; the bar only shows while it also has tools to show.


x ​

x: number

Defined in: ui/src/favorites-model.ts:20

Position as fractions (0 to 1) of the room the bar has to move in inside the plot: 0 is the left (top) edge, 1 the right (bottom) edge. Fractions keep the bar in the same spot, and inside the plot, when the chart resizes.


y ​

y: number

Defined in: ui/src/favorites-model.ts:21