Class: TimeScaleModel
Defined in: layout/viewport/time-scale-model.ts:153
Constructors
Constructor
new TimeScaleModel(
options?):TimeScaleModel
Defined in: layout/viewport/time-scale-model.ts:169
Parameters
options?
Returns
TimeScaleModel
Accessors
fit
Get Signature
get fit():
TimeScaleFit
Defined in: layout/viewport/time-scale-model.ts:206
Returns
Set Signature
set fit(
f):void
Defined in: layout/viewport/time-scale-model.ts:214
Live. 'pane' (default) fits the measured pane width; 'preset' ignores it; a
TimeUnitWidth states one unit's width in pixels; an explicit number is pxPerMs.
Every mode floors at the preset's minTickWidthPx — a range wider than the
floor allows scrolls; pick a coarser preset to fit more (#477).
Parameters
f
Returns
void
preset
Get Signature
get preset():
ViewPreset
Defined in: layout/viewport/time-scale-model.ts:176
Returns
Set Signature
set preset(
ref):void
Defined in: layout/viewport/time-scale-model.ts:187
Live — every config key is live-reconfigurable (plans/02 §1.1). Resolved through
resolvePreset (throws UnknownPresetError for an unknown id); no-op, no invalidation, when
the resolved preset is unchanged.
Shipped-only — this model has no zoomPresets ladder of its own to search (it can be shared
by more than one Gantt, each with a different ladder, so it has none), so a custom id here
is always UnknownPresetError, unlike gantt.preset (#489 owner ruling).
Parameters
ref
Returns
void
range
Get Signature
get range():
TimeSpan|"fitDataset"
Defined in: layout/viewport/time-scale-model.ts:194
Returns
TimeSpan | "fitDataset"
Set Signature
set range(
r):void
Defined in: layout/viewport/time-scale-model.ts:200
Live. 'fitDataset' spans every bound dataset's entries; a TimeSpan pins the axis. Anchored
zoom (Viewport.zoomTo/zoomBy) never writes this (D-F′) — only a caller does.
Parameters
r
TimeSpan | "fitDataset"
Returns
void
scale
Get Signature
get scale():
TimeScale
Defined in: layout/viewport/time-scale-model.ts:220
Returns
Methods
batch()
batch(
run):void
Defined in: layout/viewport/time-scale-model.ts:232
Several writes, at most one notification, delivered iff the resolved scale actually changed.
Re-entrant; flushes at the outermost exit, in a finally so a throwing run cannot
wedge the model (conventions §5).
Parameters
run
() => void
Returns
void