Add complete example coverage

Author: root

.github/workflows/pages.yml

@@ -30,6 +30,9 @@ jobs:
       - name: Install dependencies
         run: npm ci
 
+      - name: Check example coverage
+        run: npm run check:examples
+
       - name: Prepare versioned demo asset
         run: cp public/demo.js public/demo-${{ github.sha }}.js
 

README.md

@@ -368,6 +368,7 @@ Search-focused guides:
 - `p.set_axis_limits_constraints(...)`, `p.set_axis_zoom_constraints(...)`, `p.set_axis_link(...)`
 - `p.hide_next_item()`
 - `p.on_perf_stats(callback, interval_ms=500)`
+- `p.on_view_change(callback)`
 - `p.on_tool_change(callback)`
 - `p.on_selection_change(callback)`
 - `p.on_select(callback)`

app/page.jsx

@@ -109,6 +109,13 @@ const examples = [
     text: "Use the selector, slider, and buttons to verify that heatmaps and colorbar widgets use the active ImPlot colormap.",
     code: 'plot.setColormap("Plasma");\nplot.colormapSelector({ label: "Choose map" });\nplot.colormapSlider({ label: "Sample" });',
   },
+  {
+    id: "advanced-api-plot",
+    section: "Advanced API",
+    title: "View, Constraints, Axis Links, Raw Primitives",
+    text: "A focused API coverage example for view/perf callbacks, manual render scheduling, axis constraints/state/linking, aligned groups, time axes, and direct primitive access.",
+    code: 'plot.onViewChange(console.log);\nplot.setAxisLimitsConstraints("y1", -1.4, 1.4);\nplot.setAxisLink("x2", "x1");\nplot.primitive("tag_y", { value: 0.85 });',
+  },
 ];
 
 export default function Page() {

docs/EXAMPLES.md

@@ -265,6 +265,50 @@ p.set_view(1000, 5000, float(y.min()), float(y.max()))
 p.render()
 ```
 
+## Advanced API Controls
+
+```python
+advanced_view_events = []
+advanced_perf_events = []
+
+x = (np.arange(240, dtype=np.float32) * 60.0).astype(np.float32)
+y = (0.7 * np.sin(np.arange(240, dtype=np.float32) * 0.08)).astype(np.float32)
+y2 = (120 + 35 * np.sin(np.arange(240, dtype=np.float32) * 0.05)).astype(np.float32)
+
+p = ip.Plot(width=1100, height=520, title="Advanced API Controls")
+
+def on_view(plot, view):
+    advanced_view_events.append(view)
+
+def on_perf(plot, stats):
+    advanced_perf_events.append(stats)
+
+p.on_view_change(on_view)
+p.on_perf_stats(on_perf, interval_ms=500)
+p.set_plot_flags(no_legend=False, no_menus=False, no_box_select=False, crosshairs=True)
+p.set_subplots_config(rows=1, cols=2, flags=0)
+p.set_aligned_group("advanced-api", enabled=True, vertical=True)
+p.set_secondary_axes(x2=True, y2=True)
+p.set_time_axis("x1")
+p.set_axis_state("x2", enabled=True, scale="time")
+p.set_axis_state("y2", enabled=True, scale="linear")
+p.set_axis_link("x2", "x1")
+p.set_axis_limits_constraints("y1", -1.4, 1.4)
+p.set_axis_zoom_constraints("x1", 5 * 60, 180 * 60)
+p.set_axis_ticks("x1", np.array([0, 1800, 3600, 5400], dtype=np.float32),
+                 labels=["00:00", "00:30", "01:00", "01:30"], keep_default=False)
+p.clear_axis_ticks("x2")
+
+p.line("primary", y, x=x, subplot_index=0)
+p.line("secondary y2", y2, x=x, y_axis="y2", subplot_index=0)
+p.inf_lines("maintenance", np.array([3600, 7200], dtype=np.float32), axis="x", subplot_index=0)
+p.tag_y(0.85, label_fmt="tag_y wrapper", round_value=False, subplot_index=0)
+p.scatter("linked samples", y[::5], x=x[::5], subplot_index=1)
+p.set_view(0, 4 * 3600, -1.25, 1.25)
+p.render()
+p.show()
+```
+
 ## Subplots
 
 ```python
@@ -301,7 +345,11 @@ def on_tool(plot, payload):
 def on_sel(plot, payload):
     print("selection:", payload)
 
+def on_view(plot, view):
+    print("view:", view)
+
 p.on_perf_stats(on_perf, interval_ms=1000)
+p.on_view_change(on_view)
 p.on_tool_change(on_tool)
 p.on_selection_change(on_sel)
 p.show()

notebooks/nbimplot_api_gallery.ipynb

@@ -2092,6 +2092,77 @@
     "al.show()\n"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Advanced API Controls\n",
+    "\n",
+    "This section collects the less common control APIs in one runnable example:\n",
+    "`on_view_change`, `on_perf_stats`, `set_plot_flags`, `set_axis_state`, `set_time_axis`,\n",
+    "`set_axis_limits_constraints`, `set_axis_zoom_constraints`, `set_axis_link`,\n",
+    "`set_aligned_group`, custom ticks plus `clear_axis_ticks`, subplots, secondary axes,\n",
+    "and lifecycle calls such as `p.render()`, `p.show()`, and `p.close()` when you are done.\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "advanced_view_events = []\n",
+    "advanced_perf_events = []\n",
+    "\n",
+    "x_adv = (np.arange(240, dtype=np.float32) * 60.0).astype(np.float32)\n",
+    "y_adv = (0.7 * np.sin(np.arange(240, dtype=np.float32) * 0.08) + 0.25 * np.cos(np.arange(240, dtype=np.float32) * 0.017)).astype(np.float32)\n",
+    "y_adv2 = (120 + 35 * np.sin(np.arange(240, dtype=np.float32) * 0.05) + 12 * np.cos(np.arange(240, dtype=np.float32) * 0.19)).astype(np.float32)\n",
+    "\n",
+    "p = ip.Plot(width=1100, height=520, title=\"Advanced API Controls\")\n",
+    "\n",
+    "def on_view(plot, view):\n",
+    "    advanced_view_events.append(view)\n",
+    "    print(\"view\", view)\n",
+    "\n",
+    "def on_perf(plot, stats):\n",
+    "    advanced_perf_events.append(stats)\n",
+    "\n",
+    "p.on_view_change(on_view)\n",
+    "p.on_perf_stats(on_perf, interval_ms=500)\n",
+    "p.set_plot_flags(no_legend=False, no_menus=False, no_box_select=False, crosshairs=True)\n",
+    "p.set_subplots_config(rows=1, cols=2, flags=0)\n",
+    "p.set_aligned_group(\"advanced-api-gallery\", enabled=True, vertical=True)\n",
+    "p.set_secondary_axes(x2=True, y2=True)\n",
+    "p.set_time_axis(\"x1\")\n",
+    "p.set_axis_state(\"x2\", enabled=True, scale=\"time\")\n",
+    "p.set_axis_state(\"y2\", enabled=True, scale=\"linear\")\n",
+    "p.set_axis_link(\"x2\", \"x1\")\n",
+    "p.set_axis_limits_constraints(\"y1\", -1.4, 1.4)\n",
+    "p.set_axis_zoom_constraints(\"x1\", 5 * 60, 180 * 60)\n",
+    "p.set_axis_label(\"x1\", \"time axis\")\n",
+    "p.set_axis_label(\"x2\", \"linked time axis\")\n",
+    "p.set_axis_label(\"y1\", \"signal\")\n",
+    "p.set_axis_label(\"y2\", \"load\")\n",
+    "p.set_axis_format(\"y1\", \"%.2f\")\n",
+    "p.set_axis_format(\"y2\", \"%.0f\")\n",
+    "\n",
+    "ticks = np.array([0, 1800, 3600, 5400, 7200, 9000, 10800, 12600], dtype=np.float32)\n",
+    "labels = [\"00:00\", \"00:30\", \"01:00\", \"01:30\", \"02:00\", \"02:30\", \"03:00\", \"03:30\"]\n",
+    "p.set_axis_ticks(\"x1\", ticks, labels=labels, keep_default=False)\n",
+    "p.set_axis_ticks(\"x2\", ticks, labels=labels, keep_default=False)\n",
+    "p.clear_axis_ticks(\"x2\")\n",
+    "\n",
+    "h = p.line(\"primary\", y_adv, x=x_adv, subplot_index=0, color=\"#1f6f66\", line_weight=2.0)\n",
+    "p.line(\"secondary y2\", y_adv2, x=x_adv, y_axis=\"y2\", subplot_index=0, color=\"#b74b2b\", line_weight=1.6)\n",
+    "p.inf_lines(\"maintenance windows\", np.array([3600, 7200, 10800], dtype=np.float32), axis=\"x\", subplot_index=0)\n",
+    "p.tag_y(0.85, label_fmt=\"tag_y wrapper\", round_value=False, subplot_index=0)\n",
+    "p.scatter(\"linked samples\", y_adv[::5], x=x_adv[::5], subplot_index=1, marker=\"diamond\", size=4.0)\n",
+    "p.line(\"linked trend\", y_adv, x=x_adv, subplot_index=1, color=\"#3f5f8f\")\n",
+    "p.set_view(0, 4 * 3600, -1.25, 1.25)\n",
+    "p.render()\n",
+    "p.show()\n"
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "b554df42",

notebooks/nbimplot_colab_complete.ipynb

@@ -2158,6 +2158,77 @@
     "al.show()\n"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Advanced API Controls\n",
+    "\n",
+    "This section collects the less common control APIs in one runnable example:\n",
+    "`on_view_change`, `on_perf_stats`, `set_plot_flags`, `set_axis_state`, `set_time_axis`,\n",
+    "`set_axis_limits_constraints`, `set_axis_zoom_constraints`, `set_axis_link`,\n",
+    "`set_aligned_group`, custom ticks plus `clear_axis_ticks`, subplots, secondary axes,\n",
+    "and lifecycle calls such as `p.render()`, `p.show()`, and `p.close()` when you are done.\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "advanced_view_events = []\n",
+    "advanced_perf_events = []\n",
+    "\n",
+    "x_adv = (np.arange(240, dtype=np.float32) * 60.0).astype(np.float32)\n",
+    "y_adv = (0.7 * np.sin(np.arange(240, dtype=np.float32) * 0.08) + 0.25 * np.cos(np.arange(240, dtype=np.float32) * 0.017)).astype(np.float32)\n",
+    "y_adv2 = (120 + 35 * np.sin(np.arange(240, dtype=np.float32) * 0.05) + 12 * np.cos(np.arange(240, dtype=np.float32) * 0.19)).astype(np.float32)\n",
+    "\n",
+    "p = ip.Plot(width=1100, height=520, title=\"Advanced API Controls\")\n",
+    "\n",
+    "def on_view(plot, view):\n",
+    "    advanced_view_events.append(view)\n",
+    "    print(\"view\", view)\n",
+    "\n",
+    "def on_perf(plot, stats):\n",
+    "    advanced_perf_events.append(stats)\n",
+    "\n",
+    "p.on_view_change(on_view)\n",
+    "p.on_perf_stats(on_perf, interval_ms=500)\n",
+    "p.set_plot_flags(no_legend=False, no_menus=False, no_box_select=False, crosshairs=True)\n",
+    "p.set_subplots_config(rows=1, cols=2, flags=0)\n",
+    "p.set_aligned_group(\"advanced-api-gallery\", enabled=True, vertical=True)\n",
+    "p.set_secondary_axes(x2=True, y2=True)\n",
+    "p.set_time_axis(\"x1\")\n",
+    "p.set_axis_state(\"x2\", enabled=True, scale=\"time\")\n",
+    "p.set_axis_state(\"y2\", enabled=True, scale=\"linear\")\n",
+    "p.set_axis_link(\"x2\", \"x1\")\n",
+    "p.set_axis_limits_constraints(\"y1\", -1.4, 1.4)\n",
+    "p.set_axis_zoom_constraints(\"x1\", 5 * 60, 180 * 60)\n",
+    "p.set_axis_label(\"x1\", \"time axis\")\n",
+    "p.set_axis_label(\"x2\", \"linked time axis\")\n",
+    "p.set_axis_label(\"y1\", \"signal\")\n",
+    "p.set_axis_label(\"y2\", \"load\")\n",
+    "p.set_axis_format(\"y1\", \"%.2f\")\n",
+    "p.set_axis_format(\"y2\", \"%.0f\")\n",
+    "\n",
+    "ticks = np.array([0, 1800, 3600, 5400, 7200, 9000, 10800, 12600], dtype=np.float32)\n",
+    "labels = [\"00:00\", \"00:30\", \"01:00\", \"01:30\", \"02:00\", \"02:30\", \"03:00\", \"03:30\"]\n",
+    "p.set_axis_ticks(\"x1\", ticks, labels=labels, keep_default=False)\n",
+    "p.set_axis_ticks(\"x2\", ticks, labels=labels, keep_default=False)\n",
+    "p.clear_axis_ticks(\"x2\")\n",
+    "\n",
+    "h = p.line(\"primary\", y_adv, x=x_adv, subplot_index=0, color=\"#1f6f66\", line_weight=2.0)\n",
+    "p.line(\"secondary y2\", y_adv2, x=x_adv, y_axis=\"y2\", subplot_index=0, color=\"#b74b2b\", line_weight=1.6)\n",
+    "p.inf_lines(\"maintenance windows\", np.array([3600, 7200, 10800], dtype=np.float32), axis=\"x\", subplot_index=0)\n",
+    "p.tag_y(0.85, label_fmt=\"tag_y wrapper\", round_value=False, subplot_index=0)\n",
+    "p.scatter(\"linked samples\", y_adv[::5], x=x_adv[::5], subplot_index=1, marker=\"diamond\", size=4.0)\n",
+    "p.line(\"linked trend\", y_adv, x=x_adv, subplot_index=1, color=\"#3f5f8f\")\n",
+    "p.set_view(0, 4 * 3600, -1.25, 1.25)\n",
+    "p.render()\n",
+    "p.show()\n"
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "b554df42",

package.json

@@ -5,6 +5,7 @@
   "type": "module",
   "scripts": {
     "dev": "next dev",
+    "check:examples": "python3 scripts/check_example_coverage.py",
     "build": "next build",
     "start": "next start"
   },

packages/web/README.md

@@ -96,9 +96,14 @@ Core methods:
 - `handle.setData(y, { x })`
 - `handle.append(y)`
 - `plot.render()`
+- `plot.requestRender()` / `plot.draw()`
 - `plot.autoscale()`
 - `plot.setView(xMin, xMax, yMin, yMax)`
+- `plot.getView()`
+- `plot.getPerfStats()`
 - `plot.dispose()`
+- `plot.onViewChange(callback)`
+- `plot.onPerfStats(callback)`
 - `plot.onHover(callback)`
 - `plot.onClick(callback)`
 - `plot.onSelection(callback)` / `plot.onSelect(callback)`
@@ -158,6 +163,25 @@ Selection events include the ImPlot rectangle plus per-series x-index ranges fro
 WASM. `indicesForSelection(...)` computes exact y-filtered indices only when
 called.
 
+## View, Axis, and Perf Controls
+
+```js
+plot.setPlotFlags({ noLegend: false, noMenus: false, noBoxSelect: false, crosshairs: true });
+plot.setSecondaryAxes({ x2: true, y2: true });
+plot.setTimeAxis("x1");
+plot.setAxisState("x2", { enabled: true, scale: "time" });
+plot.setAxisLink("x2", "x1");
+plot.setAxisLimitsConstraints("y1", -1.4, 1.4);
+plot.setAxisZoomConstraints("x1", 300, 10800);
+plot.setAlignedGroup("advanced-api", { enabled: true, vertical: true });
+
+plot.onViewChange((view) => console.log(view));
+plot.onPerfStats((stats) => console.log(stats.frameMs));
+console.log(plot.getView(), plot.getPerfStats());
+plot.requestRender();
+plot.draw();
+```
+
 For explicit x coordinates:
 
 ```js