Browse docs
Schema API
Use this reference for existing sources/panels integrations. A source
selects a storage driver and format reader; panels bind its fields to views.
For new dataset viewers, start with Dataset and .dreamrc.
The two APIs have different schemas and React entry points.
Quick start
Pass a parsed VizSchema to DatasetPreview. This LeRobot example omits
panels to generate a layout from the episode's available fields:
Auto-laying out…
Code AutoLayoutSpec.tsx
Add panels to select cameras or joint traces and control their arrangement.
Parse YAML in your application before passing the object to DatasetPreview.
How to read these docs
Follow schema configuration to bind fields. Choose storage for access, an adapter for the format, and views for display.
For a custom reader or view, use the Model contract.
DatasetPreview props
| Prop | Type | Default | Meaning |
|---|---|---|---|
schema | VizSchema | required | Parsed sources and optional panels. |
layout | 'grid' | 'row' | 'grid' | A vertical layout or compact horizontally scrolling row. Views without row support are skipped in row mode. |
clock | TimelineClock | null | local clock | Optional shared playback clock. |
extensions | DatasetPreviewExtensions | omitted | Storage, adapter and view registrations. See registration behavior. |
className | string | omitted | Container classes. |
scrollRef | React.Ref<HTMLDivElement> | omitted | Reference to the outer container. |