charton

Appearance

charton API

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

Interface: VolumeProfileOptions ​

Defined in: packages/core/src/profile/series.ts:19

Options for a volume profile series (chart.addVolumeProfile): one profile for the visible bars or one per session, its rows, width and placement, the value area, its lines and colours.

Properties ​

color? ​

optional color?: string

Defined in: packages/core/src/profile/series.ts:59

Row colour when bars carry no buy/sell split. Defaults to theme.line.

downColor? ​

optional downColor?: string

Defined in: packages/core/src/profile/series.ts:63

Sell-side rows. Defaults to theme.down.

legend? ​

optional legend?: boolean

Defined in: packages/core/src/profile/series.ts:22

false leaves this series out of the legend. Default true.

opacity ​

opacity: number

Defined in: packages/core/src/profile/series.ts:55

Row opacity inside the value area; rows outside it are fainter.

placement? ​

optional placement?: "left" | "right"

Defined in: packages/core/src/profile/series.ts:44

Edge the rows grow from: the plot edge for the visible range (default right), or the session edge for sessions (default left).

pocColor? ​

optional pocColor?: string

Defined in: packages/core/src/profile/series.ts:65

Point-of-control line. Defaults to theme.text.

pocLine ​

pocLine: boolean

Defined in: packages/core/src/profile/series.ts:56

range ​

range: VolumeProfileRange

Defined in: packages/core/src/profile/series.ts:23

rows? ​

optional rows?: number

Defined in: packages/core/src/profile/series.ts:31

Rows across each profile's price range; ignored when rowSize is set. Unset (the default), the visible-range profile has one row per 10 css px of its height, the default bar spacing, so rows stay readable at any zoom. Session profiles, computed once, follow their bar count instead (see ProfileRowOptions.rows).

rowSize? ​

optional rowSize?: number

Defined in: packages/core/src/profile/series.ts:33

Fixed row height in price units. Rows then align to multiples of it.

sessionOf ​

sessionOf: (time) => number

Defined in: packages/core/src/profile/series.ts:51

Session id of a bar time; consecutive bars with the same id share one session profile. Defaults to the UTC calendar day (utcDaySession).

Parameters ​

time ​

number

Returns ​

number

throttleMs ​

throttleMs: number

Defined in: packages/core/src/profile/series.ts:53

Minimum time between recomputes while the view or the live bar changes (ms).

title ​

title: string

Defined in: packages/core/src/profile/series.ts:20

upColor? ​

optional upColor?: string

Defined in: packages/core/src/profile/series.ts:61

Buy-side rows. Defaults to theme.up.

valueArea ​

valueArea: number

Defined in: packages/core/src/profile/series.ts:46

Share of the volume inside the value area, in percent.

valueAreaColor? ​

optional valueAreaColor?: string

Defined in: packages/core/src/profile/series.ts:67

Value-area high/low lines. Defaults to theme.textMuted.

valueAreaLines ​

valueAreaLines: boolean

Defined in: packages/core/src/profile/series.ts:57

width? ​

optional width?: number

Defined in: packages/core/src/profile/series.ts:39

Length of the fullest row: a fraction of the plot width for the visible range, or of the session width for sessions. Default 0.5: the fullest row ends at the middle, so the bars stay readable on the other half.