Built on top of d3.js and stack.gl, plotly.js is a high-level, declarative charting library. plotly.js ships with 20 chart types, including 3D charts, statistical graphs, and SVG maps.
- Quick start options
- Modules
- Bugs and feature requests
- Documentation
- Contributing
- Community
- Clients for R, Python, Node, and MATLAB
- Creators
- Copyright and license
It is important to note that logging is turned off by default in v1.13.0 onwards.
To turn logging on for development, you will want to run
Plotly.setPlotConfig({ logging: 2 }) before any plotting.
See this file for more details.
and use the plotly.js dist file(s). More info here.
git clone https://github.com/plotly/plotly.js.gitand use the plotly.js dist file(s).
npm install plotly.jsand use the plotly.js dist file(s) or require plotly.js using CommonJS as var Plotly = require('plotly.js');.
<!-- Latest compiled and minified plotly.js JavaScript -->
<script type="text/javascript" src="https://cdn.plot.ly/plotly-latest.min.js"></script>
<!-- OR use a specific plotly.js release (e.g. version 1.5.0) -->
<script type="text/javascript" src="https://cdn.plot.ly/plotly-1.5.0.min.js"></script>
<!-- OR an un-minified version is also available -->
<script type="text/javascript" src="https://cdn.plot.ly/plotly-latest.js"></script>and use the Plotly object in the window scope.
Read the Getting started page for more examples.
If you would like to reduce the bundle size of plotly.js, you can create a custom bundle by using plotly.js/lib/core, and loading only the trace types that you need (e.g. pie or choropleth). The recommended way to do this is by creating a bundling file:
// in custom-plotly.js
var Plotly = require('plotly.js/lib/core');
// Load in the trace types for pie, and choropleth
Plotly.register([
require('plotly.js/lib/pie'),
require('plotly.js/lib/choropleth')
]);
module.exports = Plotly;Then elsewhere in your code:
var Plotly = require('./path/to/custom-plotly');To learn more about the plotly.js module architecture, refer to our modularizing monolithic JS projects post.
Important: the plotly.js code base contains some non-ascii characters. Therefore, please make sure to set the charset attribute to "utf-8" in the script tag that imports your plotly.js bundle. For example:
<script type="text/javascript" src="my-plotly-bundle.js" charset="utf-8"></script>Browserify transforms are required to build plotly.js, namely, glslify to transform WebGL shaders and cwise to compile component-wise array operations. To make the trace module system work with Webpack, you will need to install ify-loader and add it to your webpack.config.json for your build to correctly bundle plotly.js files.
Have a bug or a feature request? Please first read the issues guidelines.
Official plotly.js documentation is hosted on plot.ly/javascript.
These pages are generated by the Plotly documentation repo built with Jekyll and publicly hosted on GitHub Pages. For more info about contributing to Plotly documentation, please read through contributing guidelines.
You can also suggest new documentation examples by submitting a Codepen on community.plot.ly with tag plotly-js.
Please read through our contributing guidelines. Included are directions for opening issues, using plotly.js in your project and notes on development.
- Follow @plotlygraphs on Twitter for the latest Plotly news.
- Follow @plotly_js on Twitter for plotly.js release updates.
- Implementation help may be found on community.plot.ly (tagged
plotly-js) or on Stack Overflow (taggedplotly). - Developers should use the keyword
plotlyon packages which modify or add to the functionality of plotly.js when distributing through npm. - Direct developer email support can be purchased through a Plotly Pro plan.
This project is maintained under the Semantic Versioning guidelines.
See the Releases section of our GitHub project for changelogs for each release version of plotly.js.
Open-source clients to the plotly.js APIs are available at these links:
| GitHub repo | Getting started | |
|---|---|---|
| R / RStudio | ropensci/plotly | plot.ly/r/getting-started |
| Python / Pandas / IPython notebook | plotly/plotly.py | plot.ly/python/getting-started |
| MATLAB | plotly/matlab-api | plot.ly/matlab/getting-started |
| node.js / Tonicdev / Jupyter notebook | plotly/plotly-notebook-js | |
| node.js cloud client | plotly/plotly-nodejs | plot.ly/nodejs/getting-started |
| Julia | plotly/Plotly.jl | plot.ly/julia/getting-started |
plotly.js charts can also be created and saved online for free at plot.ly/plot.
| Github | ||
|---|---|---|
| Alex C. Johnson | @alexcjohnson | |
| Étienne Tétreault-Pinard | @etpinard | @etpinard |
| Mikola Lysenko | @mikolalysenko | @MikolaLysenko |
| Miklós Tusz | @mdtusz | @mdtusz |
| Chelsea Douglas | @cldougl | |
| Ben Postlethwaite | @bpostlethwaite | |
| Chris Parmer | @chriddyp | |
| Alex Vados | @alexander-daniel |
Code and documentation copyright 2016 Plotly, Inc.
Code released under the MIT license.
Docs released under the Creative Commons license.