charton

Appearance

charton API

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

Class: VolumeProfile ​

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

Volume per price row, with the point of control and value area. Storage is reused across computations, so recomputing allocates nothing once warm.

Implements ​

Constructors ​

Constructor ​

new VolumeProfile(): VolumeProfile

Returns ​

VolumeProfile

Properties ​

buy ​

buy: Float64Array<ArrayBuffer>

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

Buy-side volume per row, from bars that carry buyVolume.

hasBuySell ​

hasBuySell: boolean = false

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

True when at least one binned bar carried buyVolume.

maxVolume ​

maxVolume: number = 0

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

Largest row volume, set by updateStats.

poc ​

poc: number = -1

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

Point-of-control row, or -1 when there is no volume. Set by updateStats.

rows ​

rows: number = 0

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

Implementation of ​

ProfileLayout.rows

rowSize ​

rowSize: number = 1

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

Implementation of ​

ProfileLayout.rowSize

sell ​

sell: Float64Array<ArrayBuffer>

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

Sell-side volume per row (volume - buyVolume of those bars).

start ​

start: number = 0

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

Implementation of ​

ProfileLayout.start

total ​

total: number = 0

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

Total binned volume.

valueAreaHigh ​

valueAreaHigh: number = -1

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

valueAreaLow ​

valueAreaLow: number = -1

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

Lowest and highest value-area rows, or -1. Set by updateStats.

volume ​

volume: Float64Array<ArrayBuffer>

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

Volume per row. Entries from rows on are unused.

Methods ​

reset() ​

reset(layout): this

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

Adopt layout and empty every row, growing storage when needed.

Parameters ​

layout ​

ProfileLayout

Returns ​

this

rowHigh() ​

rowHigh(row): number

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

Parameters ​

row ​

number

Returns ​

number

rowLow() ​

rowLow(row): number

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

Parameters ​

row ​

number

Returns ​

number

rowPrice() ​

rowPrice(row): number

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

Middle price of a row.

Parameters ​

row ​

number

Returns ​

number

updateStats() ​

updateStats(valueAreaPercent?): this

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

Recompute the largest row, point of control and value area.

Parameters ​

valueAreaPercent? ​

number = 70

Returns ​

this