blazeplot 0.2.1 → 0.3.0

package/README.md

@@ -2,6 +2,7 @@
   <img src="assets/blazeplot.png" alt="BlazePlot" width="720" />
 </p>
 
+<noscript><a href="https://liberapay.com/cervelli/donate"><img src="https://img.shields.io/liberapay/patrons/cervelli.svg?logo=liberapay"></a></noscript>
 [![npm version](https://img.shields.io/npm/v/blazeplot.svg)](https://www.npmjs.com/package/blazeplot)
 [![npm downloads](https://img.shields.io/npm/dt/blazeplot.svg)](https://www.npmjs.com/package/blazeplot)
 [![license](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
@@ -158,18 +159,26 @@ import { Chart } from "blazeplot";
 import { interactionsPlugin } from "blazeplot/plugins/interactions";
 import { legendPlugin } from "blazeplot/plugins/legend";
 import { tooltipPlugin } from "blazeplot/plugins/tooltip";
+import { annotationsPlugin } from "blazeplot/plugins/annotations";
 
 const chart = new Chart(container, {
   hover: { mode: "nearest-x", group: "x" },
   plugins: [
     interactionsPlugin({ axis: "xy" }),
+    annotationsPlugin({
+      annotations: [
+        { type: "y-line", y: 0, label: "baseline" },
+        { type: "x-range", xMin: 10, xMax: 20, label: "event" },
+        { type: "point", x: 42, y: 1.2, shape: "diamond", label: "marker" },
+      ],
+    }),
     legendPlugin(),
     tooltipPlugin({ mode: "nearest-point", group: "none", maxDistancePx: 24 }),
   ],
 });
 ```
 
-Built-in plugins are optional. `interactionsPlugin()` provides plain-drag box zoom, Shift+drag plot pan, wheel zoom, double-click reset, and `axis: "x" | "y" | "xy"`. When outside axes are visible, scrolling an axis zooms that axis and dragging an axis pans that axis; the plugin also applies a subtle axis hover color/filter configurable with `axisHover`, `axisHoverColor`, and `axisHoverFilter`. Legend/tooltip consume public APIs (`getSeriesState`, `setSeriesVisible`, `pick`, and `subscribe`) so custom UI can use the same contract. The default tooltip updates while the cursor is still on live charts and highlights the raw sample(s) it is reporting. For shared time-series tooltips, use `group: "x"`; for scatter/true point hover, use `group: "none"`.
+Built-in plugins are optional. `interactionsPlugin()` provides plain-drag box zoom, Shift+drag plot pan, wheel zoom, double-click reset, and `axis: "x" | "y" | "xy"`. When outside axes are visible, scrolling an axis zooms that axis and dragging an axis pans that axis; the plugin also applies a subtle axis hover color/filter configurable with `axisHover`, `axisHoverColor`, and `axisHoverFilter`. `annotationsPlugin()` supports common plot annotations: vertical/horizontal lines, X/Y bands, boxes, point markers, and labels. Legend/tooltip consume public APIs (`getSeriesState`, `setSeriesVisible`, `pick`, and `subscribe`) so custom UI can use the same contract. The default tooltip updates while the cursor is still on live charts and highlights the raw sample(s) it is reporting. For shared time-series tooltips, use `group: "x"`; for scatter/true point hover, use `group: "none"`.
 
 ### `SeriesStore`
 
@@ -189,7 +198,7 @@ Built-in plugins are optional. `interactionsPlugin()` provides plain-drag box zo
 | `capacity` | Ring buffer capacity (samples). |
 | `id?` / `name?` | Optional metadata exposed to plugins, legend, and tooltip rows. |
 | `yAxis?` | `"left"` or `"right"`; selects the primary or secondary Y viewport/axis for this series. |
-| `downsample` | `"minmax"` or `"none"`. Min/max LOD applies to line and bar rendering; area/scatter skip LOD. |
+| `downsample` | `"minmax"` or `"none"`. Min/max LOD applies to line/bar rendering. Scatter with LOD uses a 2D viewport-aware point sampler; scatter with `"none"` renders exact 2D-culled chunks. Area renders raw sampled strips. |
 
 ### `SeriesStyle`