Skip to content

charton API


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

Interface: FootprintSeriesOptions ​

Defined in: packages/core/src/profile/footprint-series.ts:7

Options of footprintSeries, next to the custom series base options.

Properties ​

downColor? ​

optional downColor?: string

Defined in: packages/core/src/profile/footprint-series.ts:15

Rows where selling leads, and sell imbalances. Defaults to theme.down.


imbalance? ​

optional imbalance?: false | FootprintImbalanceOptions

Defined in: packages/core/src/profile/footprint-series.ts:11

Imbalance rule for coloured row text (see footprintImbalances), or false for none. Default { ratio: 3 }.


pocColor? ​

optional pocColor?: string

Defined in: packages/core/src/profile/footprint-series.ts:17

Outline of the point-of-control row. Defaults to theme.text.


upColor? ​

optional upColor?: string

Defined in: packages/core/src/profile/footprint-series.ts:13

Rows where buying leads, and buy imbalances. Defaults to theme.up.


values? ​

optional values?: "volume" | "split" | "delta"

Defined in: packages/core/src/profile/footprint-series.ts:9

Row text: 'split' sell and buy volume side by side, 'delta' buy minus sell, 'volume' the total. Default 'split'.