VisualCrew/plotly.js

The open source javascript graphing library that powers plotly

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.

Table of contents

• Quick start options
• Modules
• Bugs and feature requests
• Documentation
• Contributing
• Community
• Clients for R, Python, and MATLAB
• Creators
• Copyright and license

Quick start options

Download the latest release

Latest Release on Github

Clone the repo

git clone https://github.com/plotly/plotly.js.git

Install with npm

npm install plotly.js

Use the plotly.js CDN hosted by Fastly:

<!-- 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>

Read the Getting started page for more examples.

Modules

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 plotlyCore = require('plotly.js/lib/core');

// Load in the trace types for pie, and choropleth
plotlyCore.register([
    require('plotly.js/lib/pie'),
    require('plotly.js/lib/choropleth')
]);

module.exports = plotlyCore;

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.

Non-ascii characters

Important: the plotly.js code base contains some non-ascii characters. Therefore, please make sure to set the chartset 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>

Webpack Usage with Modules

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.

Bugs and feature requests

Have a bug or a feature request? Please first read the issues guidelines.

Documentation

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.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, using plotly.js in your project and notes on development.

Community

Get updates on plotly.js's development and chat with the project maintainers and community members.

• Follow @plotlygraphs on Twitter.
• Implementation help may be found at Stack Overflow (tagged plotly) or community.plot.ly (tagged plotly-js).
• Developers should use the keyword plotly on 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.

Versioning

plotly.js is maintained under the Semantic Versioning guidelines.

See the Releases section of our GitHub project for changelogs for each release version of plotly.js.

Clients for R, Python, Node, and MATLAB

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.

Creators

	Github	Twitter
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

Copyright and license

Code and documentation copyright 2016 Plotly, Inc.

Code released under the MIT license.

Docs released under the Creative Commons license.