Documentation / @ripl/core / ScaleBindingOptions

Interface: ScaleBindingOptions<TDomain, TRange>

Defined in: packages/core/src/scales/_base/index.ts:17

Low-level options for constructing a scale, providing conversion, inversion, inclusion, and tick generation callbacks.

Type Parameters

Type Parameter
TDomain
TRange

Properties

Property	Modifier	Type	Description	Defined in
convert	public	ScaleMethod<TDomain, TRange>	Maps a domain value to its corresponding range value.	packages/core/src/scales/_base/index.ts:23
domain	readonly	TDomain[]	The input domain the scale maps from.	packages/core/src/scales/_base/index.ts:19
invert	public	ScaleMethod<TRange, TDomain>	Maps a range value back to its corresponding domain value.	packages/core/src/scales/_base/index.ts:25
range	readonly	TRange[]	The output range the scale maps to.	packages/core/src/scales/_base/index.ts:21

Methods

includes()?

optional includes(value): boolean

Defined in: packages/core/src/scales/_base/index.ts:27

Tests whether a value falls within the domain. Defaults to a strict domain.includes check.

Parameters

Parameter	Type
value	TDomain

Returns

boolean

---

ticks()?

optional ticks(count?): TDomain[]

Defined in: packages/core/src/scales/_base/index.ts:29

Generates tick values across the domain. Defaults to returning a copy of the domain.

Parameters

Parameter	Type
count?	number

Returns

TDomain[]