Graflume · Alpha

Annotation · Basic implementation · Common features

Place important events and explanatory labels directly on a time series. Start with only the required data and family encoding. Expand the code to run the same example. Use the tabs to compare header, tooltip, theme, legend, highlight, callout, selection, view controls, and accessibility one feature at a time.

Chart family · Default families

Annotation

Place important events and explanatory labels directly on a time series.

Quick API
annotation()
Browser snapshot
graflume
mark
annotation
Presets
3

Basic implementation

The smallest runnable chart

Start with only the required data and family encoding. Expand the code to run the same example.

Basic example

Place important events and explanatory labels directly on a time series.

StatusLoading

  • minimal-implementation
Graflume.annotation() Canvas 2D
Control help

Zoom and pan inspect the rendered surface without changing data axes or values. When playback controls are available, they move through real steps in the order each unique value first appears in the source data.

Use Tab to reach a control and Enter or Space to activate it. With the chart focused, use plus and minus to zoom and arrow keys to pan.

Auto placement compares perimeter candidates and avoids the plot, legend, and other callouts when possible. Explicit placement is preserved with only necessary safety correction. Callout text wraps safely inside the bubble. Long unbroken tokens are visually shortened within the line budget, while the complete source text remains available to assistive technology.

Loading

Browser API · Portable schema

Browser API

Graflume.annotation()

const data = [
  {
    "annotation": null,
    "date": "2026-01-01",
    "value": 48
  },
  {
    "annotation": null,
    "date": "2026-02-01",
    "value": 53
  },
  {
    "annotation": "Spring release",
    "date": "2026-03-01",
    "value": 51
  },
  {
    "annotation": null,
    "date": "2026-04-01",
    "value": 59
  },
  {
    "annotation": null,
    "date": "2026-05-01",
    "value": 66
  },
  {
    "annotation": null,
    "date": "2026-06-01",
    "value": 70
  },
  {
    "annotation": null,
    "date": "2026-07-01",
    "value": 76
  },
  {
    "annotation": null,
    "date": "2026-08-01",
    "value": 82
  },
  {
    "annotation": "Team plan launch",
    "date": "2026-09-01",
    "value": 80
  },
  {
    "annotation": null,
    "date": "2026-10-01",
    "value": 89
  },
  {
    "annotation": null,
    "date": "2026-11-01",
    "value": 96
  },
  {
    "annotation": null,
    "date": "2026-12-01",
    "value": 104
  }
];

const options = {
  "height": 620,
  "locale": "en",
  "mark": {
    "fields": {
      "annotation": "annotation"
    },
    "point": true
  },
  "width": "container",
  "x": {
    "field": "date",
    "title": "Month",
    "type": "temporal"
  },
  "y": {
    "field": "value",
    "title": "Active teams",
    "type": "quantitative"
  }
};

Graflume.annotation('#chart', data, options);

Portable schema

ChartSpec 0.1 · options

{
  "height": 620,
  "locale": "en",
  "mark": {
    "fields": {
      "annotation": "annotation"
    },
    "point": true
  },
  "width": "container",
  "x": {
    "field": "date",
    "title": "Month",
    "type": "temporal"
  },
  "y": {
    "field": "value",
    "title": "Active teams",
    "type": "quantitative"
  }
}

Common features

Features shared by every chart

Use the tabs to compare header, tooltip, theme, legend, highlight, callout, selection, view controls, and accessibility one feature at a time. Hover over a data mark. On supported charts, move the pointer along the axis to see the nearest value. All exact values are available in the table below.

Header

Add a chart title and supporting description inside the visualization.

StatusLoading

  • header
Graflume.annotation() Canvas 2D
Control help

Zoom and pan inspect the rendered surface without changing data axes or values. When playback controls are available, they move through real steps in the order each unique value first appears in the source data.

Use Tab to reach a control and Enter or Space to activate it. With the chart focused, use plus and minus to zoom and arrow keys to pan.

Auto placement compares perimeter candidates and avoids the plot, legend, and other callouts when possible. Explicit placement is preserved with only necessary safety correction. Callout text wraps safely inside the bubble. Long unbroken tokens are visually shortened within the line budget, while the complete source text remains available to assistive technology.

Loading

Browser API · Portable schema

Browser API

Graflume.annotation()

const data = [
  {
    "annotation": null,
    "date": "2026-01-01",
    "value": 48
  },
  {
    "annotation": null,
    "date": "2026-02-01",
    "value": 53
  },
  {
    "annotation": "Spring release",
    "date": "2026-03-01",
    "value": 51
  },
  {
    "annotation": null,
    "date": "2026-04-01",
    "value": 59
  },
  {
    "annotation": null,
    "date": "2026-05-01",
    "value": 66
  },
  {
    "annotation": null,
    "date": "2026-06-01",
    "value": 70
  },
  {
    "annotation": null,
    "date": "2026-07-01",
    "value": 76
  },
  {
    "annotation": null,
    "date": "2026-08-01",
    "value": 82
  },
  {
    "annotation": "Team plan launch",
    "date": "2026-09-01",
    "value": 80
  },
  {
    "annotation": null,
    "date": "2026-10-01",
    "value": 89
  },
  {
    "annotation": null,
    "date": "2026-11-01",
    "value": 96
  },
  {
    "annotation": null,
    "date": "2026-12-01",
    "value": 104
  }
];

const options = {
  "axes": {
    "x": {
      "format": {
        "dateStyle": "long",
        "timeZone": "UTC",
        "type": "date"
      }
    }
  },
  "height": 620,
  "locale": "en",
  "mark": {
    "fields": {
      "annotation": "annotation"
    },
    "point": true
  },
  "title": {
    "subtitle": "Annotation chart uses runnable data and options to demonstrate datum/layer/range/plot targets; runtime CRUD.",
    "text": "Annotation"
  },
  "width": "container",
  "x": {
    "field": "date",
    "title": "Month",
    "type": "temporal"
  },
  "y": {
    "field": "value",
    "title": "Active teams",
    "type": "quantitative"
  }
};

Graflume.annotation('#chart', data, options);

Portable schema

ChartSpec 0.1 · options

{
  "axes": {
    "x": {
      "format": {
        "dateStyle": "long",
        "timeZone": "UTC",
        "type": "date"
      }
    }
  },
  "height": 620,
  "locale": "en",
  "mark": {
    "fields": {
      "annotation": "annotation"
    },
    "point": true
  },
  "title": {
    "subtitle": "Annotation chart uses runnable data and options to demonstrate datum/layer/range/plot targets; runtime CRUD.",
    "text": "Annotation"
  },
  "width": "container",
  "x": {
    "field": "date",
    "title": "Month",
    "type": "temporal"
  },
  "y": {
    "field": "value",
    "title": "Active teams",
    "type": "quantitative"
  }
}
Chart catalog