Documentation / @ripl/core / BandScale

Interface: BandScale()<TDomain>

Defined in: packages/core/src/scales/band.ts:14

A band scale that divides a continuous range into uniform bands for categorical data, exposing bandwidth and step.

Extends

• Scale<TDomain, number>

Type Parameters

Type Parameter	Default type
TDomain	string

BandScale(value): number

Defined in: packages/core/src/scales/band.ts:14

Maps a value from the input domain to the output range.

Parameters

Parameter	Type
value	TDomain

Returns

number

Properties

Property	Type	Description	Inherited from	Defined in
bandwidth	number	The width of each band, in range units, after inner padding is removed.	-	packages/core/src/scales/band.ts:16
domain	TDomain[]	The input domain the scale maps from.	Scale.domain	packages/core/src/scales/types.ts:9
inverse	ScaleMethod<number, TDomain>	Maps a value from the range back to its corresponding domain value.	Scale.inverse	packages/core/src/scales/types.ts:13
range	number[]	The output range the scale maps to.	Scale.range	packages/core/src/scales/types.ts:11
step	number	The distance between the start of adjacent bands, in range units (bandwidth plus inner padding).	-	packages/core/src/scales/band.ts:18

Methods

includes()

includes(value): boolean

Defined in: packages/core/src/scales/types.ts:17

Tests whether a value falls within the scale's domain.

Parameters

Parameter	Type
value	TDomain

Returns

boolean

Inherited from

Scale.includes

---

ticks()

ticks(count?): TDomain[]

Defined in: packages/core/src/scales/types.ts:15

Generates approximately count evenly spaced tick values across the domain.

Parameters

Parameter	Type
count?	number

Returns

TDomain[]

Inherited from

Scale.ticks