charton API / @chart-on/core / index / PrimitiveEnv
Interface: PrimitiveEnv
Defined in: packages/core/src/primitives.ts:16
Mapping and context for one drawing area. Sizes in css px, area-local.
Properties
barSpacing
barSpacing:
number
Defined in: packages/core/src/primitives.ts:24
from
from:
number
Defined in: packages/core/src/primitives.ts:22
Visible logical index range (fractional).
height
height:
number
Defined in: packages/core/src/primitives.ts:18
pixelRatio
pixelRatio:
number
Defined in: packages/core/src/primitives.ts:19
theme
theme:
ChartTheme
Defined in: packages/core/src/primitives.ts:20
times
times: readonly
number[]
Defined in: packages/core/src/primitives.ts:26
Bar times of the main series; index i is bar i.
to
to:
number
Defined in: packages/core/src/primitives.ts:23
width
width:
number
Defined in: packages/core/src/primitives.ts:17
Methods
formatPrice()
formatPrice(
price):string
Defined in: packages/core/src/primitives.ts:34
Parameters
price
number
Returns
string
indexToX()
indexToX(
index):number
Defined in: packages/core/src/primitives.ts:27
Parameters
index
number
Returns
number
priceToY()
priceToY(
price):number
Defined in: packages/core/src/primitives.ts:32
The scale of the series the primitive is attached to, or of its pane.
Parameters
price
number
Returns
number
timeToX()
timeToX(
time):number
Defined in: packages/core/src/primitives.ts:30
Times between bars are interpolated, times past the data extrapolated.
Parameters
time
number
Returns
number
xToIndex()
xToIndex(
x):number
Defined in: packages/core/src/primitives.ts:28
Parameters
x
number
Returns
number
yToPrice()
yToPrice(
y):number
Defined in: packages/core/src/primitives.ts:33
Parameters
y
number
Returns
number