Interface: Scale

Experimental

Properties

Property	Modifier	Type	Description
breaks	readonly	BreakMap | undefined	Experimental Range breaks of a date / linear axis (linear space is compressed); else undefined.
categories	readonly	readonly string[]	Experimental Categories of a category axis (index = linear coordinate); empty for other types.
length	readonly	number	Experimental Axis length in CSS px.
multicategories	readonly	readonly readonly [string, string][]	Experimental [group, item] categories of a multicategory axis; empty for other types.
range	readonly	readonly [number, number]	Experimental Visible range in linear space; range[0] > range[1] means reversed.
type	readonly	AxisType	Experimental

Methods

affine()

affine(): object;

Experimental

l2p in affine form: p = l * m + b.

Returns

object

Name	Type
b	number
m	number

---

d2l()

d2l(value): number;

Experimental

Data value → linear coordinate; NaN when not representable (≤ 0 on log, unknown category).

Parameters

Parameter	Type
value	unknown

Returns

number

---

d2lArray()

d2lArray(values, out?): Float64Array;

Experimental

Fast path for whole data arrays (typed arrays stay allocation-free when out is given).

Parameters

Parameter	Type
values	ArrayLike<unknown>
out?	Float64Array<ArrayBufferLike>

Returns

Float64Array

---

d2p()

d2p(value): number;

Experimental

Data value → pixel (l2p(d2l(v))).

Parameters

Parameter	Type
value	unknown

Returns

number

---

l2d()

l2d(l): string | number;

Experimental

Linear coordinate → data value for display (number, ms, or category name).

Parameters

Parameter	Type
l	number

Returns

string | number

---

l2p()

l2p(l): number;

Experimental

Parameters

Parameter	Type
l	number

Returns

number

---

l2r()

l2r(l): string | number;

Experimental

Linear → range value: a number, except on date axes, which give the shortest ISO string (2024-03-01 12:30), matching what users write in axis.range.

Parameters

Parameter	Type
l	number

Returns

string | number

---

p2d()

p2d(p): string | number;

Experimental

Pixel → data value (l2d(p2l(p))).

Parameters

Parameter	Type
p	number

Returns

string | number

---

p2l()

p2l(p): number;

Experimental

Parameters

Parameter	Type
p	number

Returns

number

---

r2l()

r2l(value): number;

Experimental

Range value (as in axis.range, tick0, tickvals bounds) → linear. Like d2l, except that log ranges are already exponents (Plotly semantics) and category ranges may be fractional indices as well as category names.

Parameters

Parameter	Type
value	unknown

Returns

number

---

setLength()

setLength(px): void;

Experimental

Parameters

Parameter	Type
px	number

Returns

void

---

setRange()

setRange(r0, r1): void;

Experimental

Parameters

Parameter	Type
r0	number
r1	number

Returns

void