Intermact API Reference / @intermact/core / Scale

Interface: Scale()<TDomain, TRange>

Defined in: packages/core/src/math/scale.ts:18

Maps values from a data domain to a coordinate range and back, and produces human-friendly ticks. Callable: scale(value) performs the forward mapping.

Type Parameters

TDomain

TDomain = number

Domain value type (number, or Date for time scales).

TRange

TRange = number

Range value type (always number for the v0.2 scales).

Scale(value): TRange

Defined in: packages/core/src/math/scale.ts:20

Forward map a domain value to the range.

Parameters

value

TDomain

Returns

TRange

Properties

domain

readonly domain: readonly [TDomain, TDomain]

Defined in: packages/core/src/math/scale.ts:31

---

range

readonly range: readonly [TRange, TRange]

Defined in: packages/core/src/math/scale.ts:32

Methods

invert()

invert(value): TDomain

Defined in: packages/core/src/math/scale.ts:22

Inverse map a range value back to the domain.

Parameters

value

TRange

Returns

TDomain

---

tickFormat()

tickFormat(count?, spec?): (value) => string

Defined in: packages/core/src/math/scale.ts:30

Build a formatter for ticks. count matches the tick request (so decimals track the tick step); spec is an optional minimal format hint ("%" for percent, ".<n>f" for fixed decimals).

Parameters

count?

number

spec?

string

Returns

(value) => string

---

ticks()

ticks(count?): TDomain[]

Defined in: packages/core/src/math/scale.ts:24

Generate approximately count nicely-rounded ticks across the domain.

Parameters

count?

number

Returns

TDomain[]