Plotly.js can be used to produce dozens of chart types and visualizations, including statistical charts, 3D graphs, scientific charts, SVG and tile maps, financial charts and more.
Contact us for Plotly.js consulting, dashboard development, application integration, and feature additions.
Table of contents
- Quick start options
- Building plotly.js
- Bugs and feature requests
- Notable Contributors
- Copyright and license
Quick start options
Install with npm
npm install plotly.js-dist
and import plotly.js as
import Plotly from 'plotly.js-dist' // Or using require, var Plotly = require('plotly.js-dist')
Use the plotly.js CDN hosted by Fastly
and use the
Plotly object in the window scope.
Fastly supports Plotly.js with free CDN service. Read more at https://www.fastly.com/open-source
Download the latest release
and use the plotly.js
dist file(s). More info here.
Getting started page for more examples.Read the
v1.15.0, plotly.js ships with several partial bundles (more info here).
v1.39.0, plotly.js publishes distributed npm packages with no dependencies. For example, run
npm install plotly.js-geo-dist and add
import Plotly from 'plotly.js-geo-dist'; to your code to start using the plotly.js geo package.
If none of the distributed npm packages meet your needs, and you would like to manually pick which plotly.js modules to include, you'll first need to run
npm install plotly.js and then create a custom bundle by using
plotly.js/lib/core, and loading only the trace types that you need (e.g.
choropleth). The recommended way to do this is by creating a bundling file. For example, in CommonJS:
// 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');
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 src="my-plotly-bundle.js" charset="utf-8"></script>
Building instructions using
browserify and other build frameworks are in
Bugs and feature requests
These pages are generated by the Plotly graphing-library-docs repo built with Jekyll and publicly hosted on GitHub Pages. For more info about contributing to Plotly documentation, please read through contributing guidelines.
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.
- Implementation help may be found on community.plot.com (tagged
plotly-js) or on Stack Overflow (tagged
- Developers should use the keyword
plotlyon packages which modify or add to the functionality of plotly.js when distributing through npm.
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.
Plotly.js is at the core of a large and dynamic ecosystem with many contributors who file issues, reproduce bugs, suggest improvements, write code in this repo (and other upstream or downstream ones) and help users in the Plotly community forum. The following people deserve special recognition for their outsized contributions to this ecosystem:
|Alex C. Johnson||@alexcjohnson||Active, Maintainer|
|Mojtaba Samimi||@archmoj||@solarchvision||Active, Maintainer|
|Antoine Roy-Gobeil||@antoinerg||Active, Maintainer|
|Étienne Tétreault-Pinard||@etpinard||@etpinard||Hall of Fame|
|Mikola Lysenko||@mikolalysenko||@MikolaLysenko||Hall of Fame|
|Ricky Reusser||@rreusser||@rickyreusser||Hall of Fame|
|Dmitry Yv.||@dy||@DimaYv||Hall of Fame|
|Robert Monfera||@monfera||@monfera||Hall of Fame|
|Robert Möstl||@rmoestl||@rmoestl||Hall of Fame|
|Nicolas Riesco||@n-riesco||Hall of Fame|
|Miklós Tusz||@mdtusz||@mdtusz||Hall of Fame|
|Chelsea Douglas||@cldougl||Hall of Fame|
|Ben Postlethwaite||@bpostlethwaite||Hall of Fame|
|Chris Parmer||@chriddyp||Hall of Fame|
|Alex Vados||@alexander-daniel||Hall of Fame|
Copyright and license
Code and documentation copyright 2020 Plotly, Inc.
Code released under the MIT license.