scale-fill-stepsn

Binned n-stop fill gradient.

Fill counterpart of scale-colour-stepsn.

Usage

scale-fill-stepsn(
  colours,
  n-breaks,
  breaks,
  name,
  limits,
  oob,
  labels,
)

Parameters

Parameter Default Description
colours Array of two or more colours.
n-breaks Number of bins to partition the domain into. Ignored when breaks is set.
breaks Array of bin edges, or auto to derive equal-width bins from n-breaks. Edges define the bin boundaries; n-breaks is ignored when set.
name Legend title. Overrides any name set via labels when both are present.
limits Pair (lo, hi) clipping the trained domain, or none.
oob Out-of-range policy: "drop" (default) removes rows whose value falls outside limits; "squish" clamps continuous values to the nearest endpoint.
labels Array of legend labels aligned with the bins, or auto.

Returns

Scale object consumed by plot.

Examples

Three-stop ramp discretised into six bins, shown as a swatch via geom-rect.

#let d = range(0, 16).map(i => (
  xmin: i, xmax: i + 1, ymin: 0, ymax: 1, z: i,
))
#plot(
  data: d,
  mapping: aes(xmin: "xmin", xmax: "xmax", ymin: "ymin", ymax: "ymax", fill: "z"),
  layers: (geom-rect(),),
  scales: (scale-fill-stepsn(colours: (
    rgb("#1a9850"), rgb("#ffffbf"), rgb("#d73027"),
  ), n-breaks: 6),),
  guides: guides(fill: none),
  theme: theme-void(),
  width: 10cm,
  height: 1cm,
)

Colour-bar swatch of sixteen rectangles displaying a custom three-stop n-stop fill ramp cut into six stepped bands passing green through pale yellow to red.

Colour-bar swatch of sixteen rectangles displaying a custom three-stop n-stop fill ramp cut into six stepped bands passing green through pale yellow to red.

See also

scale-colour-stepsn, scale-fill-steps, scale-fill-steps2.

Back to top