Skip to content
Reference Band

Reference Band

Add a shaded horizontal band from y0 to y1 on the y-axis.

Reference Band

Usage

from dataviz_mojo.plot import Plot, save

def main() raises:
    var x: List[Float64] = [1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0]
    var latency: List[Float64] = [42.0, 48.0, 45.0, 61.0, 55.0, 58.0, 70.0, 63.0]

    var plot = (
        Plot()
        .mark_line()
        .encode(x=x, y=latency)
        .labels(title="Response Time (ms)", subtitle="Against an acceptable range")
        .annotate_area(50.0, 60.0, label="acceptable range")
    )
    save(plot, "docs/src/examples/out_annotate_area.svg")

Args:

  • y0: One edge of the band; need not be the lower one.
  • y1: The other edge of the band; whichever of y0/y1 is smaller becomes the band’s bottom edge.
  • label: Drawn inside the band near its top edge when non-empty; left empty (the default), the band draws with no label.