cue.parameter

cue.parameterNode

The same parameter, swept by the scene. Identical to parameter down to the last attribute, plus the two a cue takes: at:, the anchor it starts on, and duration:, how long it takes to run its range end to end. A choropleth moving through its years is cue.parameter:t(over: #pop.year; at: 2); the same letter dragged by hand instead is parameter:t(over: #pop.year). It is a cue rather than a play: flag because everything that follows from being one is wanted: the anchor is the ordinary one, the host's transport finds the sweep by walking anchors as it finds every other piece of choreography, and the play, pause and replay the reader gets are the step's. duration: is the time to cross the whole range, so a default: part way along it finishes in proportionally less. The reader still gets the slider, and dragging it displaces the sweep rather than stopping it: playing on carries the letter from wherever they let go, at the rate the author set. What moves is the sweep's own elapsed time and never the scene clock — moving that would drag every other cue in the scene along with it — and their displacement is handed back when they leave the step or replay it.

#Attributes

varRequiredImplicit
Variable name (single letter, a-z).Can be written as shorthand: cue.parameter:value
Also written: labelWhat the parameter is called in front of a reader. Rich text, so Frequency bb sets its own maths.
Also written: period, columnA dataset column the parameter runs over: over: #pop.year. Its cells are the stops, their span is the range, and what they are decides the format — so range: is not consulted where this is given. This is the shape long-format data arrives in, and the shape a mark's period: reads: the mark names the column, not the parameter, and the two meet at the column.
format
autonumbersdatesmonthsweekdayshoursweeks
Also written: valuesWhat the values are, for the readout: numbers, dates, months, weekdays, hours or weeks. Each places a value on its own number line — position 1…12 for a month, a fractional year for a date — so the range stays a pair of numbers and only the reading changes. auto takes the kind from the column over: names, and is numeric where no column was named; writing it beside over: overrules the cells, which is what to reach for where a column of 1…12 means months.
Defaultauto
Range interval [start, end]. Ignored where over: names a column: the data decides.
Default[-10, 10]
step
Distance between stops. Absent, 1 — or, under over:, the closest the data's own values come to each other, which is the spacing that can reach every row.
default
Also written: startWhere it starts. Absent, 0 — or, under over:, the first value in the column.
discrete
Also written: steppedStand on one stop at a time. Continuous (the default), the parameter moves through the gaps between stops and the marks glide with it; discrete, it snaps to the nearest — the data's own values, or the step ladder — and the marks jump from one slice to the next, for a quantity that is not a continuous function of the axis.
Defaultfalse
hiddenAnimatable
Keeps the parameter out of the footer: the expressions still use it, the reader cannot move it.
Defaultfalse
Also written: lockedKeeps the reader from editing it on an editable: graph.
Defaultfalse
When the sweep starts — a step index (2), a time (1.5s), or the compound form (3 + 1.5s), read exactly as every other cue anchor is.
Default0
duration
How long the sweep takes to run the range end to end, written as a duration like every other in the language: 8s, 1500ms.
Default8s
easing
linearsmooth
How the sweep is paced. linear by default and not smooth: a parameter's range is a scale the reader reads values off, and easing in and out of it would make the same span of screen mean different amounts of the quantity at different moments.
Defaultlinear

#Derived attributes

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

valueDerived
Where the letter currently stands: the sweep, displaced by whatever the reader has dragged.

#Allowed in

#Examples

cue.parameter#years(var: t; over: #rates.year; name: Year; at: 1; duration: 12s)
cue.parameter:a(range: [0, 4]; at: 2; duration: 3s)