Features · annotation

Shaded band / region

native

Highlighted range on an axis

Matrix status native. Verification types · strong. ChartKit option: ChartKitChartSpecV1.annotations.

{type:'band', from, to}

Source: chartkit:packages/core/src/generated/schema.ts:69

ChartKit spec

Passed validate() during npm run matrix:refresh. The SVG is the server render.

Units rose in Q2.Units rose in Q2.Mark40455055Q1Q2
{
  "version": "1",
  "type": "line",
  "data": [
    {
      "quarter": "Q1",
      "units": 40
    },
    {
      "quarter": "Q2",
      "units": 55
    }
  ],
  "encoding": {
    "x": "quarter",
    "y": "units"
  },
  "a11y": {
    "alt": "Units rose in Q2."
  },
  "size": {
    "width": 640,
    "height": 260
  },
  "annotations": [
    {
      "type": "rule",
      "axis": "y",
      "value": 50,
      "label": "Mark"
    }
  ]
}

Other libraries

Option names are the paths recorded in the matrix. A grep-only cell names the identifier that matched, not a render test. Markdown copy: annotation.band.md.

LibraryStatusOptionVerificationSource
Chart.jsplugin—npm · weak—
RechartsnativeReferenceAreatypes · strongrecharts/types/cartesian/ReferenceArea.d.ts:129
Apache EChartsnativeseries.markAreatypes · strongecharts/types/dist/shared.d.ts:12498
HighchartsnativexAxis.plotBandstypes · stronghighcharts/highcharts.d.ts:108576
Plotly.jsnativelayout.shapestypes · strongplot-schema.json#layout.layoutAttributes.shapes
NivomanualLine.layersmechanism · weak@nivo/line/dist/types/types.d.ts:171
VictorymanualVictoryBarProps.dataComponentmechanism · weakvictory-core/lib/victory-util/common-props.d.ts:9
visxmanualGroupmechanism · weak@visx/group/lib/Group.d.ts:15
ApexChartsnativeannotations.xaxisx2 / y2 make a bandtypes · strongapexcharts/types/apexcharts.d.ts:2659
Tremor (npm)none—absence · absence—
Observable PlotnativerectX, rectYtypes · strong@observablehq/plot/src/marks/rect.d.ts:257
Vega-Litenativemark=recttypes · strongvega-lite/build/spec/unit.d.ts:19
AG Chartsnativegrep: crossLinestype 'range'grep · weakag-charts-enterprise/dist/types/src/main.d.ts:9
amCharts 5nativegrep: axisFillgrep · weak@amcharts/amcharts5/.internal/charts/xy/series/XYSeries.d.ts:740
Google Chartsnone—absence · absence—
uPlotnativeOptions.bandsbands are between series; manual region via hookstypes · stronguplot/dist/uPlot.d.ts:377
TradingView Lightweight Chartsnone—absence · absence—
MUI X ChartsmanualChartsContainermechanism · weak@mui/x-charts/ChartsContainer/ChartsContainer.d.mts:34
Mermaid (chart-ish diagrams only)none—absence · absence—
AntV G2nativeMarkTypes=rangeX, MarkTypes=rangeYtypes · strong@antv/g2/lib/spec/mark.d.ts:13