API reference#
Complete reference for the widgets, tutorial datasets, HTML export, and data loading / I/O. Common display-chrome names and presets are documented in Viewer UI controls. Named tutorial datasets are documented in Tutorial Datasets. Package-level GIF and MP4 writers are documented in Movie Export. The same tables are surfaced in the developer-facing UI Guide. Widget pages have two halves:
Reference - the constructor signature, every parameter, and every public method, generated directly from the source by static analysis (so it never drifts from the code).
Interactive controls - the UI elements the widget exposes and the synced trait each one drives.
Doubles as a UI-test spec#
The Interactive controls tables are the contract an automated agent drives the widget against. Each row names a control, the trait it mutates, and what should be observed after acting on it. A driving agent reads the table, performs the action over CDP, and asserts the trait moved and the canvas repainted (non-zero, no console error, no NaN frame). When a control changes, update the table here in the same commit; the published page is the source of truth for both human readers and test agents.
At a glance#
Widget |
Class |
Offline export |
|---|---|---|
|
state JSON, CSV, PNG/PDF via Python, interactive HTML |
|
|
state JSON, PNG, interactive HTML ( |
|
|
state JSON, PNG, interactive HTML ( |
|
|
state JSON, PNG, interactive HTML ( |
|
|
state JSON, PNG, interactive WebGPU HTML; large exports use a companion data directory |
|
|
state JSON, interactive HTML; large exact data use folder export, portable demos use downsampled HTML |
|
|
state JSON, PNG, interactive HTML |
|
|
selection JSON for selected microscopy files and folders |
All widget-level HTML exports follow the HTML export protocol.