Plottable.js is a library of chart components for creating flexible, custom charts for websites. It is built on top of D3.js and provides higher-level pieces, like plots, gridlines, and axes. As such, it's easier to quickly build charts than with D3, and the charts are much more flexible than standard-template charts provided by charting libraries. You can think of Plottable as a "D3 for Charts" — it is not a charting library but rather a library of chart components. Check out examples of Plottable on our website's examples page.
Plottable's core philosophy is "Composition over Configuration", so a lot of the API flexibility is in choosing which
Components to use, and how to arrange them in
Tables, rather than setting high-level properties on the charts. If you find you need a feature that doesn't exist, consider writing a new
Component that implements the functionality. This way, you can get your custom functionality and still benefit from the rest of the library.
- Get Plottable:
- Check out examples
- Read the tutorials
- Visit the website, plottablejs.org
Upgrading to v1.0.0
If you are upgrading from a pre-v1.0.0 version of Plottable to v1.0.0 or later, please use the Upgrade Guide on the wiki.
We Want To Help!
If you run into any problems using Plottable, please let us know. We want Plottable to be easy-to-use, so if you are getting confused, it is our fault, not yours. Create an issue and we'll be happy to help you out, or drop by our Gitter room.
- Clone the repo
- Install global dependencies
npm install grunt grunt-cli -g
- Install local dependencies
gruntand it will spin up a server (pointed at http://localhost:9999) and begin compiling the typescript code
- If you get an EACCESS error at any point, instead of running command with
sudotry first changing permission to following folders:
sudo chown -R "$(whoami)" /usr/local
sudo chown -R "$(whoami)" ~/.npm/
- Navigate to
http://localhost:9999/quicktests/and choose a directory to view visual tests
Build source into javacript with
Install as dependency into project locally with
npm install --save ../plottabledir
This will put the built version into
- Write your code
- Add tests for new functionality, and please add some quicktests too
grunt testand verify it completes with no warnings or failures
- Commit new files, including the updated built files like
- Fill out the Personal or Corporate Contributor License Agreement and send it to firstname.lastname@example.org
- You can do this easily on a Mac by using the Tools - Annotate - Signature feature in Preview.
- Submit a pull request