Skip to content

charton API


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

Interface: NumericPrimitiveEnv ​

Defined in: packages/core/src/numeric/types.ts:25

Coordinates and context for a NumericPrimitive, in plot-local css px.

Properties ​

from ​

from: number

Defined in: packages/core/src/numeric/types.ts:32

The visible x range, low to high (also when the axis is inverted).


height ​

height: number

Defined in: packages/core/src/numeric/types.ts:28


pixelRatio ​

pixelRatio: number

Defined in: packages/core/src/numeric/types.ts:29


theme ​

theme: ChartTheme

Defined in: packages/core/src/numeric/types.ts:30


to ​

to: number

Defined in: packages/core/src/numeric/types.ts:33


width ​

width: number

Defined in: packages/core/src/numeric/types.ts:27

The plot size.

Methods ​

formatPrice() ​

formatPrice(price): string

Defined in: packages/core/src/numeric/types.ts:41

A price as the crosshair labels it.

Parameters ​

price ​

number

Returns ​

string


formatX() ​

formatX(x): string

Defined in: packages/core/src/numeric/types.ts:39

An x value as the crosshair labels it.

Parameters ​

x ​

number

Returns ​

string


pixelToX() ​

pixelToX(px): number

Defined in: packages/core/src/numeric/types.ts:35

Parameters ​

px ​

number

Returns ​

number


priceToY() ​

priceToY(price): number

Defined in: packages/core/src/numeric/types.ts:36

Parameters ​

price ​

number

Returns ​

number


xToPixel() ​

xToPixel(x): number

Defined in: packages/core/src/numeric/types.ts:34

Parameters ​

x ​

number

Returns ​

number


yToPrice() ​

yToPrice(y): number

Defined in: packages/core/src/numeric/types.ts:37

Parameters ​

y ​

number

Returns ​

number