parameter.time

parameter.timeNode

A parameter whose axis is TIME. Under the skin it is an ordinary parameter — it owns a letter, lives in the same value map, and prose cites it the same way with {{#id.value}} — but it takes its range FROM the data rather than being told one, reads as a period rather than a decimal, and can play, because a time axis has both a direction and a duration. Name the period column of a long-format table and the environment gains a scrubber spanning exactly what that column covers; every mark in the same environment carrying a period: slices itself against it.

#Attributes

periodRequiredImplicit
Also written: over, columnThe period column: period: #rates.year. Its distinct values give the scrubber both its range and its natural stops.Can be written as shorthand: parameter.time:value
The letter an expression reaches the current period by.
Defaultt
Also written: labelWhat the scrubber is called in front of a reader. Rich text.
step
Distance between stops, in the period column's own units. Absent, the periods present in the data are the stops.
default
Also written: startThe period the scrubber starts on. Absent, the earliest one in the data.
duration
How long playing takes to run from the first period to the last, written as a duration like every other in the language: 8s, 1500ms.
Default8s
discrete
Also written: steppedStand on one period at a time. Continuous (the default), the axis moves through the gaps between periods and the marks glide with it; discrete, it snaps to the nearest stop — the data's own periods, or the step ladder — and the marks jump from one slice to the next, for data that is not a continuous function of time.
Defaultfalse
hiddenAnimatable
Keeps the scrubber out of the footer: marks still slice against the period and prose can still cite it, but the reader cannot move it.
Defaultfalse
Also written: lockedThe scrubber is shown but is not the reader's to move.
Defaultfalse

#Derived attributes

Computed while the element renders — read one with #id.name in attribute position or {{#id.name}} in prose, never set.

valueDerived
The period the reader is standing on. Cite it in prose with {{round(#id.value, 0)}}.

#Allowed in

#Examples

parameter.time#years(period: #rates.year; name: Year)
parameter.time(period: #rates.year; step: 1; duration: 12s)