Skip to content

Developing a new visualization

Jorge Yagüe París edited this page Jan 30, 2017 · 4 revisions

This manual is intended for developers that want to contribute to Proteic adding new visualizations.

  1. Declare the new module in index.ts
  2. Create a new file in src/charts/, named after your new visualization. This file will hold the TypeScript class that represents the visualization.
  3. Create the default configuration for the visualization, in src/utils/defaults/, named after the visualization.
  4. Create the strategy class to draw the visualization, in src/svg/strategies/.
  5. Add the necessary components to src/svg/components/. You can re-use the existing ones, if possible.
  6. Add one example using your new visualization to examples/.
  7. Add tests and documentation.
Clone this wiki locally