axis.band

axis.bandNode

Shades an interval on an axis across the whole plot — a reference band the marks are read against: an operating range, the recession quarters, $\pm\sigma$. It draws under the grid and the marks. The axis is chosen by which interval is given, as with axis.label's coordinate.

#Attributes

On any plane

labelImplicit
rich-text
Also written: text, nameThe name at the band's edge. Rich text; optional — a band says something with no words on it.Can be written as shorthand: axis.band:value
colourAnimatable
neutralredorangeyellowgreentealbluepurplepinkgreywhiteblack
Also written: colorBand and label colour.
Defaultgrey
opacityAnimatable
number
The wash's opacity.
Default0.15
edgesAnimatable
boolean
Dashed hairline rules at the band's two edges.
Defaultfalse
sizeAnimatable
number
Also written: text-sizeLabel text size.
Default20
hiddenAnimatable
boolean
Declared but not drawn. Animatable, for reveals.
Defaultfalse
Only withxplane
xAnimatable
axis-interval
The interval to shade along the x axis, e.g. [2008, 2009.5]. Give exactly one of x or y; either end may ride a parameter. On a categorical axis the ends are names, [Tue, Thu] — a band to a name covers that name’s whole share of the axis.
Only withxyplane
xAnimatable
axis-interval
The interval to shade along the x axis, e.g. [2008, 2009.5]. Give exactly one of x or y; either end may ride a parameter. On a categorical axis the ends are names, [Tue, Thu] — a band to a name covers that name’s whole share of the axis.
yAnimatable
axis-interval
The interval to shade along the y axis. On a categorical axis the ends are names, [Tue, Thu] — a band to a name covers that name’s whole share of the axis.
Only withargandplane
reAnimatable
axis-interval
On the argand plane, the interval on the real axis; naming it selects the axis.
imAnimatable
axis-interval
On the argand plane, the interval on the imaginary axis; naming it selects the axis.
Only withpolarplane
rAnimatable
axis-interval
On the polar plane, the interval on the r axis; naming it selects the axis. A band on r is an annulus.
thetaAnimatable
axis-interval
On the polar plane, the interval on the theta axis, in radians (60deg for degrees) or a name; naming it selects the axis. A band on theta is a sector.

#Allowed in

canvas.graph { }cue { }cue.draw { }cue.trace { }cue.highlight { }cue.spotlight { }

#Examples

axis.band(label: recession; x: [2008, 2009.5])
axis.band(y: [-1, 1]; colour: teal; edges: true)