Features · annotation

Point marker / callout

native

Marker or arrow highlighting a point

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

Point, leader, and a text box kept inside the plot. Later callouts move clear of earlier ones.

Source: chartkit:packages/core/src/annotations.ts:19

ChartKit spec

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

Units rose in Q2.Units rose in Q2.Peak40455055Q1Q2
{
  "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": "marker",
      "x": "Q2",
      "label": "Peak"
    }
  ]
}

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.marker.md.

LibraryStatusOptionVerificationSource
Chart.jsplugin—npm · weak—
RechartsnativeReferenceDottypes · strongrecharts/types/cartesian/ReferenceDot.d.ts:137
Apache EChartsnativeseries.markPointtypes · strongecharts/types/dist/shared.d.ts:12500
Highchartsnativegrep: annotationsshapes + labelsgrep · weakhighcharts/highcharts.src.d.ts:162
Plotly.jsnativelayout.annotationsshowarrowtypes · strongplot-schema.json#layout.layoutAttributes.annotations
Nivonativegrep: annotations@nivo/annotationsgrep · weak@nivo/scatterplot/package.json:39
VictorymanualVictoryBarProps.dataComponentmechanism · weakvictory-core/lib/victory-util/common-props.d.ts:9
visxnativeAnnotation, Connectortypes · strong@visx/annotation/lib/components/Annotation.d.ts:7
ApexChartsnativeannotations.pointstypes · strongapexcharts/types/apexcharts.d.ts:2660
Tremor (npm)none—absence · absence—
Observable Plotnativearrow, dottypes · strong@observablehq/plot/src/marks/arrow.d.ts:111
Vega-LitemanualTopLevelSpec.layermechanism · weakvega-lite/build/spec/layer.d.ts:27
AG Chartsnativegrep: annotationsgrep · weakag-charts-types/dist/types/src/main.d.ts:7
amCharts 5nativegrep: CalloutSeriesgrep · weak@amcharts/amcharts5/stock.d.ts:56
Google Chartsnone—absence · absence—
uPlotmanualOptions.hooksmechanism · weakuplot/dist/uPlot.d.ts:394
TradingView Lightweight Chartsnativegrep: SeriesMarkerseries markers (arrows/circles) at timesgrep · weak274: * import { createSeriesMarkers } from 'lightweight-charts';
MUI X ChartsmanualChartsContainermechanism · weak@mui/x-charts/ChartsContainer/ChartsContainer.d.mts:34
Mermaid (chart-ish diagrams only)none—absence · absence—
AntV G2nativegrep: annotationgrep · weak@antv/g2/lib/component/constant.d.ts:22