Documentation / @ripl/core / PointScale
Interface: PointScale()<TDomain>
Defined in: packages/core/src/scales/point.ts:22
A point scale that positions discrete domain values at evenly spaced points, exposing the step.
Extends
Scale<TDomain,number>
Type Parameters
| Type Parameter | Default type |
|---|---|
TDomain | string |
PointScale(
value):number
Defined in: packages/core/src/scales/point.ts:22
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 |
|---|---|---|---|---|
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 adjacent points, in range units. | - | packages/core/src/scales/point.ts:24 |
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
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[]