Features · annotation

Text annotation at a data point

native

Label pinned to data coordinates

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

{type:'text', x, y, label}

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

LibraryStatusOptionVerificationSource
Chart.jsplugin—npm · weak—
RechartsnativeReferenceDot, Labeltypes · strongrecharts/types/cartesian/ReferenceDot.d.ts:137
Apache EChartsnativeseries.markPointtypes · strongecharts/types/dist/shared.d.ts:12500
Highchartsnativegrep: annotationsannotations module labelsgrep · weakhighcharts/highcharts.src.d.ts:162
Plotly.jsnativelayout.annotationstypes · strongplot-schema.json#layout.layoutAttributes.annotations
NivonativeLine.markerstypes · strong@nivo/line/dist/types/types.d.ts:186
VictorynativeVictoryLabeltypes · strongvictory-core/lib/victory-label/victory-label.d.ts:54
visxnativeAnnotation, Labeltypes · strong@visx/annotation/lib/components/Annotation.d.ts:7
ApexChartsnativeannotations.pointstypes · strongapexcharts/types/apexcharts.d.ts:2660
Tremor (npm)none—absence · absence—
Observable Plotnativetexttypes · strong@observablehq/plot/src/marks/text.d.ts:211
Vega-Litenativemark=texttypes · strongvega-lite/build/spec/unit.d.ts:19
AG Chartsnativegrep: annotationsenterprise annotations / crossLines labelgrep · weakag-charts-types/dist/types/src/main.d.ts:7
amCharts 5nativegrep: Labelgrep · weak@amcharts/amcharts5/stock.d.ts:55
Google Chartsnativegrep: annotationannotation role columngrep · weak@types/google.visualization/index.d.ts:402
uPlotmanualOptions.hooksmechanism · weakuplot/dist/uPlot.d.ts:394
TradingView Lightweight Chartsnativegrep: createSeriesMarkersgrep · weak274: * import { createSeriesMarkers } from 'lightweight-charts';
MUI X ChartsmanualChartsContainermechanism · weak@mui/x-charts/ChartsContainer/ChartsContainer.d.mts:34
Mermaid (chart-ish diagrams only)unknown—conflict · unknown—
AntV G2nativeMarkTypes=texttypes · strong@antv/g2/lib/spec/mark.d.ts:13