API reference
import observablejs as obs
The top-level package exports the runtime objects and cell helpers:
| Export | Contract |
|---|---|
Notebook | Controls a notebook definition and Python-owned state. |
NotebookView | Renders selected cells and exposes one consistent browser state. |
view_from_* | Builds a full renderable view through a standalone factory. |
NotebookCell | Identifies one notebook-owned cell by key. |
Cell | Describes one authored cell. |
ojs, js, md, html | Create common cell modes. |
NotebookGraph | Contains cells and symbolic dependencies. |
CellInfo | Describes one graph cell. |
DependencyEdge | Links source and target cells through one variable. |
NOTEBOOK_THEMES | Lists accepted Notebook Kit themes. |
types | Namespaces advanced typed mappings and state records. |
Use Source constructors for imported notebooks,
File attachments for files, and Variables and
serialization for state conversion.
Use Data access to inspect source and read evaluated datasets.
Use Errors and diagnostics for ready(), raise_for_errors(), and
the observablejs.errors exception namespace.