cue.highlight

A cue that draws attention to what it wraps with rings pushed out from its edge.

On this page
Three frames of a highlight: five readings, then two rings pushing out from the teal one and thinning as they grow, then the rings gone and the readings as they were.Three frames of a highlight: five readings, then two rings pushing out from the teal one and thinning as they grow, then the rings gone and the readings as they were.

#Attributes

atImplicit
When the rings start, for a highlight timed as a gesture: a step (1), a time on the scene's clock (1.5s) or a step with an offset (1 + 500ms). Unwritten, with no in: either, step 0. Not written with in: or out:.
Can be written as shorthand: cue.highlight:value
in
When a HELD highlight takes hold, in place of at: and duration:: it rings in as ever, then keeps one quiet ring on its content until out: — emphasis for the stretch of the narrative about it, however long the reader stays there.
out
When a held highlight lets go: after its in:. Left out, it holds to the end of the scene.
in-duration
How long a held highlight's quiet ring takes to come on.
Default400ms
out-duration
How long a held highlight's quiet ring takes to go.
Default400ms
duration
How long one ring takes. The whole gesture, both rings, lasts 1.3 times this. On a code environment's lines, how long the wash lasts.
Default1500ms
colour
The rings' colour. Left out, the colour of the first thing inside that has one.
paint
Also written: color
easing
Shape of the rise and fall: smooth or linear.
linearsmooth
Defaultsmooth
sequential
Rings each element of the body in turn, top to bottom, each when the rings round the one before have gone.
Defaultfalse

#Allowed content

#Allowed in

#Examples

Three frames of the second step: five readings, then rings pushing out from the teal one, then the rings gone.Three frames of the second step: five readings, then rings pushing out from the teal one, then the rings gone.
graph{
    scatter(x: 1, 2, 3, 5; y: 1.2, 2.1, 1.8, 2.6; colour: grey)
    cue.highlight{
        point(x: 4; y: 4; colour: teal)
    }(
        at: 2
    )
}(
    x-domain: [0, 6]
    y-domain: [0, 5]
)
Three frames of a parabola pulsing orange for two seconds.Three frames of a parabola pulsing orange for two seconds.
graph{
    cue.highlight{
        curve(expression: x^2)
    }(
        at: 1
        duration: 2s
        colour: orange
    )
}(
    x-domain: [-3, 3]
    y-domain: [0, 9]
)

#Notes

  • Two rings push out of the content's edge and fade as they grow, the second paler and setting off 30% of the way through the first.
  • Presence is untouched, so it nests inside a cue, cue.draw or cue.write to ring content that cue brought in.
  • On a code environment's lines it is a wash over the lines instead.

#Writing guidance

  • Framing a readable graph — When to write a domain, the defaults left alone, naming a series, the ticks the prose reads, and one meaning per hue.

Last updated