Skip to content

charton API


charton API / @chart-on/core / index / SessionBandsOptions

Interface: SessionBandsOptions ​

Defined in: packages/core/src/session-bands.ts:43

Options for session bands: thin strips or full-height columns, strip height and spacing, and opacity.

Properties ​

bandGap ​

bandGap: number

Defined in: packages/core/src/session-bands.ts:49

Space between strips in 'bands' mode, css px.


bandHeight ​

bandHeight: number

Defined in: packages/core/src/session-bands.ts:47

Height of each lane's strip in 'bands' mode, css px.


columnOpacity ​

columnOpacity: number

Defined in: packages/core/src/session-bands.ts:53

Column opacity in 'columns' mode, multiplied with opacity; keeps columns faint behind the series.


mode ​

mode: SessionBandsMode

Defined in: packages/core/src/session-bands.ts:45


opacity ​

opacity: number

Defined in: packages/core/src/session-bands.ts:51

Multiplies the lane colour's alpha: strips in 'bands' mode, columns in 'columns' mode.


visible ​

visible: boolean

Defined in: packages/core/src/session-bands.ts:44