Skip to content

Meta-Storyboard (MSB)

npm version License: MIT Build Status

Meta-Storyboard (MSB) is a JavaScript/TypeScript library that enables the creation of scalable, interactive, and animated data visualizations using the feature-action design pattern. The library offers a set of APIs with the following key features:

  • Feature Detection: Built-in peak and event detection utilities.
  • Action Mapping: Map features to visual actions (dots, circles, connectors, text boxes, etc.).
  • Animated Plots: Animate transitions and storytelling sequences.
  • Extensible Components: Register custom feature detectors and action types via FeatureFactory.register() and ActionFactory.register().
  • Table Validation: Validate feature-action tables with validateFeatureActionTable() and a shipped JSON Schema.
  • Example Stories and Playground: Test and explore components in isolation.

Installation

npm install meta-storyboard # or
yarn add meta-storyboard

Where to go next

  • Getting Started — the four-step process for building a story, with copy-paste templates.
  • Feature-Action Table — the data structures that define a meta-story.
  • API Design — feature, action, search, and plot APIs with class diagrams.
  • Live Examples — interactive stories running in the browser; see the Examples page for a guided list.

References

Our work is described in:

Khan, S., Jones, S., Bach, B., Cha, J., Chen, M., Meikle, J., Roberts, J. C., Thiyagalingam, J., Wood, J., & Ritsos, P. D. (2024). Feature-Action Design Patterns for Storytelling Visualizations with Time Series Data. arXiv preprint arXiv:2402.03116.

See About for the full citation, license, and support information.