Skip to content

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

Type Parameters

Type ParameterDefault type
TDomainstring

PointScale(value): number

Defined in: packages/core/src/scales/point.ts:22

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

Parameters

ParameterType
valueTDomain

Returns

number

Properties

PropertyTypeDescriptionInherited fromDefined in
domainTDomain[]The input domain the scale maps from.Scale.domainpackages/core/src/scales/types.ts:9
inverseScaleMethod<number, TDomain>Maps a value from the range back to its corresponding domain value.Scale.inversepackages/core/src/scales/types.ts:13
rangenumber[]The output range the scale maps to.Scale.rangepackages/core/src/scales/types.ts:11
stepnumberThe 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

ParameterType
valueTDomain

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

ParameterType
count?number

Returns

TDomain[]

Inherited from

Scale.ticks