charton

Appearance

charton API

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

Interface: ProfileOptions ​

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

Options for computeVolumeProfile: its rows and the share of volume in the value area.

Extends ​

Properties ​

rows? ​

optional rows?: number

Defined in: packages/core/src/profile/math.ts:27

Rows across the price range; used when rowSize is not set. Unset, the row count follows the bar count by the Rice rule, ceil(2 * n^(1/3)), a standard histogram bin count; the profile series and the drawing size their rows by pixels instead (onScreenRows).

Inherited from ​

ProfileRowOptions.rows

rowSize? ​

optional rowSize?: number

Defined in: packages/core/src/profile/math.ts:29

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

Inherited from ​

ProfileRowOptions.rowSize

valueArea? ​

optional valueArea?: number

Defined in: packages/core/src/profile/math.ts:35

Share of the total volume inside the value area, in percent. Default 70.