Skip to content

release v1.5.0: generic Plot panel, db3 remote URL loading#9

Merged
joaner merged 15 commits into
ioai-tech:mainfrom
joaner:main
Jun 4, 2026
Merged

release v1.5.0: generic Plot panel, db3 remote URL loading#9
joaner merged 15 commits into
ioai-tech:mainfrom
joaner:main

Conversation

@joaner
Copy link
Copy Markdown
Contributor

@joaner joaner commented Jun 4, 2026

feat: generic Plot panel, db3 remote URL loading, and release v1.5.0

Description

This PR brings @ioai/rosview from 1.3.5 → 1.5.0 with a new generic Plot panel, remote db3 URL loading, player streaming APIs for time-range reads, and a round of panel/build refactors.

Plot panel (new)

  • Adds a full Plot panel with topic/path series, schema registry, Foxglove Plot layout adapter, legend/settings UI, CSV export, and extensive unit tests.
  • JointStatePlot remains for existing layouts but is hidden from the panel picker; new users add Plot instead.
  • Foxglove legacy Plot layouts now map to the generic Plot adapter (previously redirected to JointStatePlot).
  • Plot data loading uses a new IterablePlayer.streamMessagesInTimeRange async generator so charts update incrementally instead of waiting for a full range scan.
  • Plot fixes: smoother incremental rendering during load, stable bounded Y-axis paths, hyphen slice syntax in message paths, removed reset-zoom control.

db3 remote URL loading

  • db3.worker accepts a remote url (in addition to local file / files).
  • Because SQLite needs whole-file random access, the worker downloads the full db3 in-memory (with progress) before opening — not true Range streaming like mcap/bag.
  • EMBEDDING.md / EMBEDDING.zh.md updated accordingly; wasm-zstd ≥ 1.1.2 troubleshooting notes merged from the 1.3.5 release branch.

Player & sources

  • IterablePlayer: new streamMessagesInTimeRange(); existing getMessagesInTimeRange() preserved (drains the stream internally).
  • Player state exposes randomAccessByTopic from initialization.
  • Iterable sources (bag, mcap, db3, hdf5, bvh) aligned with random-access metadata.

Refactors & tooling

  • Panel lazy-load targets renamed Component.tsx*Panel.tsx; panel-specific modules unified under core/ directories (Align, Audio, Image, ThreeD, etc.).
  • Vite lib build: custom chunk file naming and asset directory tweaks.
  • New npm run check:i18n script (scripts/check-i18n.mjs); Plot panel strings added for en / zh / ja.
  • Welcome screen layout simplification; getAddablePanelDefinitions() filters panels hidden from the picker.

Release

  • Version bumped to 1.5.0 in package.json and package-lock.json.

Diff summary: origin/main is 14 commits ahead of upstream/main154 files, +7915 / −570 lines.

Motivation / related issue

  • Closes the gap with Foxglove-style Plot workflows (multi-topic time series, layout import) while keeping JointStatePlot backward-compatible.
  • Enables remote db3 URLs for embedders without requiring host-side download-to-File boilerplate.
  • Incremental range reads fix Plot flicker and improve responsiveness on large bags/MCAP files.

Related PRs on the fork: #1 (Plot panel), #3 (db3 URL + Next.js guide).

Type of change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing behavior to change)
  • Documentation update
  • Refactor / internal cleanup (no behavior change)

Note: Foxglove Plot layout import behavior changes (generic Plot instead of JointStatePlot redirect). Existing JointStatePlot panels still load. Not a published npm API break — see API compatibility below.

Checklist

  • npm run lint passes with no errors
  • npm test passes (unit tests)
  • npm run build and npm run build:lib succeed
  • New behavior is covered by tests (or explain why tests aren't applicable) — Plot panel, message paths, datasets, range reader, IterablePlayer, i18n registry, settings primitives
  • Documentation updated (README, API.md, EMBEDDING.md) if the public API changed — EMBEDDING.md / EMBEDDING.zh.md updated for db3 URL loading
  • Breaking change: all affected call sites updated and migration path described in PR description — N/A for npm exports; layout migration noted above

API compatibility

No changes to src/entrypoints/index.ts — published @ioai/rosview exports are unchanged.

Internal / behavioral changes:

Area Impact
Plot panel New panel type Plot in registry; Foxglove Plot adapter targets generic Plot
JointStatePlot hideFromPanelPicker: true; still registered for legacy layouts
getAddablePanelDefinitions() New registry helper (filters Unavailable and hidden panels)
IterablePlayer.streamMessagesInTimeRange() New async iterable for batched range reads; getMessagesInTimeRange() unchanged signature
StreamMessagesInTimeRangeArgs New player type with optional maxMessages, batchSize, batchWallTimeMs
db3 worker Accepts url + optional knownTotalBytes; error message updated when neither url nor files provided
npm run check:i18n New dev script (not part of library exports)

Screenshots / recordings

joaner and others added 15 commits May 27, 2026 15:27
…tructure

Implement a new function for generating chunk file names for lazy panel UI components, ensuring a consistent naming convention. Additionally, modify the output configuration to place assets directly in the root of the dist-lib directory, streamlining the build output structure.
Align panel chunk naming with ThreeD/Pose so dist-lib outputs identifiable
{PanelName}Panel-*.js chunks instead of generic Component-*.js files.
Shorten the shared 3D rendering module path and update imports across
ThreeD, Pose, UrdfDebug, and urdf-preview entrypoint.
Move align-core, image-core, and audio-core into Align/core, Image/core,
and Audio/core to match the ThreeD panel layout and simplify import paths.
…recation (#1)

* feat(plot): implement Plot panel with dataset handling and configuration

Add a new Plot panel feature, including components for rendering plots, managing datasets, and configuring series. Introduce utilities for reading message ranges and extracting plot path values. Implement settings for customizing plot behavior, such as axis modes and series configurations. Ensure integration with existing message pipeline for real-time data visualization.

* feat(plot): add MCAP topic inspection script and enhance plot dataset handling

Introduce a new script for inspecting MCAP topics to facilitate Plot panel fixture generation. Enhance the plot dataset handling by implementing efficient random access by topic and time, improving the overall performance and usability of the Plot panel. Update related types and configurations to support these features, ensuring better integration with existing data visualization workflows.

* feat(plot): enhance dataset handling and introduce joint state path utilities

Refactor the dataset management in the Plot panel to improve performance and usability. Introduce new utilities for handling joint state paths, including functions for combining and stripping paths. Update the message path extraction logic to support multiple comma-separated and whitespace-separated paths. Enhance the plot configuration actions and selectors for better integration with the new dataset features, ensuring a more efficient data visualization workflow.

* feat(plot): deprecate JointStatePlot and enhance panel definitions

Introduce warnings for deprecated JointStatePlot usage in the layout and runtime components, advising migration to the Plot panel. Update panel definitions to exclude JointStatePlot from addable options and implement new utilities for handling joint state paths. Enhance plot configuration normalization to support legacy series merging and improve dataset handling for better visualization workflows.

* fix(plot): improve error handling and code clarity in dataset tests and plot alignment

Enhance dataset tests by adding error checks for undefined indices, ensuring robust validation of non-null values. Refactor plot alignment logic to handle potential undefined entries gracefully. Additionally, streamline the extraction of y-values in dataset processing for better readability and maintainability. Remove unused type imports to clean up the codebase.

---------

Co-authored-by: joaner <joaner@users.noreply.github.com>
…siveness

Updated the WelcomeScreen component to enhance layout by removing unnecessary min-height constraints and adjusting flex properties for better responsiveness. This change aims to streamline the component's rendering and improve user experience on various screen sizes.
Enhance the IterablePlayer class by introducing a new method, streamMessagesInTimeRange, which allows for streaming messages in specified time ranges with configurable batch sizes and limits. This update improves the efficiency of message retrieval and supports real-time data visualization in the Plot panel. Additionally, refactor the getMessagesInTimeRange method to utilize the new streaming functionality, ensuring compatibility with existing use cases. Introduce tests for the new streaming behavior and update related types to accommodate the new parameters.
db3/SQLite cannot be Range-streamed (random access over the whole
database), so the db3 worker now downloads a remote URL in full (with
download progress) and opens it in memory. This unifies the
local-File / remote-URL access model across all formats — passing a db3
URL just works, no host-side pre-download needed.

Also:
- bump @ioai/wasm-zstd to ^1.1.2 (inline-worker blob: URL fix)
- add a Next.js (App Router / Turbopack) integration section to the
  embedding docs, plus a db3 troubleshooting note
- update architecture docs for remote db3 behavior

Bump to 1.3.5.

Co-authored-by: joaner <joaner@users.noreply.github.com>
* fix(plot): improve SettingsNumber input UX 
* fix(plot): toggling series visibility no longer triggers a re-fetch 
* fix(plot): smooth incremental updates instead of flickering during load 
* feat(plot): disable X-axis modes that need array Y-paths or an X-path 
* feat(plot): add reset-zoom button + slim load progress bar
Remove the non-functional Plot reset zoom control, localize tab context
menu and add-panel submenu strings, and add an npm check:i18n script.
Align Foxglove inclusive slice bounds for paths like position[1:2], accept
position[1-2] as an alias, remount uPlot when incremental series updates
are unsafe, and clear the dataset when plot data config changes.
Keep db3 remote URL loading documentation; clarify @ioai/wasm-zstd ≥
1.1.2 in version requirements and troubleshooting.
Plot path strings in tests and comments were mistaken for arbitrary
property utilities, producing invalid CSS that broke lightningcss minify.
@joaner joaner merged commit aba77c4 into ioai-tech:main Jun 4, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant