Skip to main content

Interface: ViewPresetHeader

Defined in: time/scale.ts:37

What a caller states about a stepping cadence — declared here, not in scale.ts, because snapInstant/nextTickBoundary need the same shape one level below TimeScale.ticks; scale.ts re-exports it (ViewPresetHeader and TimeScale.ticks both key off it too, S1.7 §3.3) so a TickStep import from either module names one type.

Extends​

Properties​

format​

format: DateFormat

Defined in: time/scale.ts:38

increment​

readonly increment: number

Defined in: time/snap.ts:27

Inherited from​

TickStep.increment

repeatCoarserUnits?​

optional repeatCoarserUnits?: boolean

Defined in: time/scale.ts:44

A coarser band earlier in headers (bands are coarsest first) that already spells out year or month makes this band drop that field from its own format by default — the day band under a month band reads "21", not "Sep 21, 2026" (S1.12 follow-up, header readability). Set true to keep this band's format exactly as written. No effect on a callback format: only Intl.DateTimeFormatOptions fields are ever inspected or stripped.

unit​

readonly unit: TimeUnit

Defined in: time/snap.ts:26

Inherited from​

TickStep.unit