README.md
Using distributed files
All plotly.js dist bundles inject an object Plotly
into the global scope.
Import plotly.js as:
<script src="plotly.min.js"></script>
or the un-minified version as:
<script src="plotly.js" charset="utf-8"></script>
To support IE9
Before the plotly.js script tag, add:
<script>if(typeof window.Int16Array !== 'function')document.write("<scri"+"pt src='extras/typedarray.min.js'></scr"+"ipt>");</script>
<script>document.write("<scri"+"pt src='extras/request_animation_frame.js'></scr"+"ipt>");</script>
To support MathJax
Before the plotly.js script tag, add:
<script src="mathjax/MathJax.js?config=TeX-AMS-MML_SVG"></script>
You can grab the relevant MathJax files in ./dist/extras/mathjax/
.
By default, plotly.js will modify the global MathJax configuration on load.
This can lead to undesirable behavior if plotly.js is loaded alongside
other libraries that also rely on MathJax. To disable this global configuration
process, set the MathJaxConfig
property to 'local'
in the window.PlotlyConfig
object. This property must be set before the plotly.js script tag, for example:
<script>
window.PlotlyConfig = {MathJaxConfig: 'local'}
</script>
<script src="plotly.min.js"></script>
To include localization
Plotly.js defaults to US English (en-US) and includes British English (en) in the standard bundle. Many other localizations are available - here is an example using Swiss-German (de-CH), see the contents of this directory for the full list. They are also available on our CDN as https://cdn.plot.ly/plotly-locale-de-ch-latest.js OR https://cdn.plot.ly/plotly-locale-de-ch-1.52.2.js Note that the file names are all lowercase, even though the region is uppercase when you apply a locale.
After the plotly.js script tag, add:
<script src="plotly-locale-de-ch.js"></script>
<script>Plotly.setPlotConfig({locale: 'de-CH'})</script>
The first line loads and registers the locale definition with plotly.js, the second sets it as the default for all Plotly plots.
You can also include multiple locale definitions and apply them to each plot separately as a config
parameter:
Plotly.newPlot(graphDiv, data, layout, {locale: 'de-CH'})
Bundle information
The main plotly.js bundle includes all the official (non-beta) trace modules.
It be can imported as minified javascript
- using dist file
dist/plotly.min.js
- using CDN URL https://cdn.plot.ly/plotly-latest.min.js OR https://cdn.plot.ly/plotly-1.52.2.min.js
or as raw javascript:
- using the
plotly.js-dist
npm package (starting inv1.39.0
) - using dist file
dist/plotly.js
- using CDN URL https://cdn.plot.ly/plotly-latest.js OR https://cdn.plot.ly/plotly-1.52.2.js
- using CommonJS with
require('plotly.js')
If you would like to have access to the attribute meta information (including attribute descriptions as on the schema reference page), use dist file dist/plotly-with-meta.js
The main plotly.js bundle weights in at:
plotly.js | plotly.min.js | plotly.min.js + gzip | plotly-with-meta.js |
---|---|---|---|
6.9 MB | 3.2 MB | 957 kB | 7.2 MB |
Partial bundles
Starting in v1.15.0
, plotly.js also ships with several partial bundles:
Starting in v1.39.0
, each plotly.js partial bundle has a corresponding npm package with no dependencies.
Starting in v1.50.0
, the minified version of each partial bundle is also published to npm in a separate "dist min" package.
plotly.js basic
The basic
partial bundle contains trace modules scatter
, bar
and pie
.
Stats
Raw size | Minified size | Minified + gzip size |
---|---|---|
2.4 MB | 853.5 kB | 280.4 kB |
CDN links
Flavor | URL |
---|---|
Latest | https://cdn.plot.ly/plotly-basic-latest.js |
Latest minified | https://cdn.plot.ly/plotly-basic-latest.min.js |
Tagged | https://cdn.plot.ly/plotly-basic-1.52.2.js |
Tagged minified | https://cdn.plot.ly/plotly-basic-1.52.2.min.js |
npm package (starting in v1.39.0
)
Install plotly.js-basic-dist
with
npm install plotly.js-basic-dist
ES6 module usage:
import Plotly from 'plotly.js-basic-dist'
CommonJS usage:
var Plotly = require('plotly.js-basic-dist');
dist min npm package (starting in v1.50.0
)
Install plotly.js-basic-dist-min
with
npm install plotly.js-basic-dist-min
Other plotly.js entry points
Flavor | Location |
---|---|
dist bundle | dist/plotly-basic.js |
dist bundle (minified) | dist/plotly-basic.min.js |
ES6 module | import Plotly from 'plotly.js/lib/index-basic' |
CommonJS | require('plotly.js/lib/index-basic') |
plotly.js cartesian
The cartesian
partial bundle contains trace modules scatter
, bar
, box
, heatmap
, histogram
, histogram2d
, histogram2dcontour
, image
, pie
, contour
, scatterternary
and violin
.
Stats
Raw size | Minified size | Minified + gzip size |
---|---|---|
2.7 MB | 983.4 kB | 321.4 kB |
CDN links
Flavor | URL |
---|---|
Latest | https://cdn.plot.ly/plotly-cartesian-latest.js |
Latest minified | https://cdn.plot.ly/plotly-cartesian-latest.min.js |
Tagged | https://cdn.plot.ly/plotly-cartesian-1.52.2.js |
Tagged minified | https://cdn.plot.ly/plotly-cartesian-1.52.2.min.js |
npm package (starting in v1.39.0
)
Install plotly.js-cartesian-dist
with
npm install plotly.js-cartesian-dist
ES6 module usage:
import Plotly from 'plotly.js-cartesian-dist'
CommonJS usage:
var Plotly = require('plotly.js-cartesian-dist');
dist min npm package (starting in v1.50.0
)
Install plotly.js-cartesian-dist-min
with
npm install plotly.js-cartesian-dist-min
Other plotly.js entry points
Flavor | Location |
---|---|
dist bundle | dist/plotly-cartesian.js |
dist bundle (minified) | dist/plotly-cartesian.min.js |
ES6 module | import Plotly from 'plotly.js/lib/index-cartesian' |
CommonJS | require('plotly.js/lib/index-cartesian') |
plotly.js geo
The geo
partial bundle contains trace modules scatter
, scattergeo
and choropleth
.
Stats
Raw size | Minified size | Minified + gzip size |
---|---|---|
2.4 MB | 880.7 kB | 289.9 kB |
CDN links
Flavor | URL |
---|---|
Latest | https://cdn.plot.ly/plotly-geo-latest.js |
Latest minified | https://cdn.plot.ly/plotly-geo-latest.min.js |
Tagged | https://cdn.plot.ly/plotly-geo-1.52.2.js |
Tagged minified | https://cdn.plot.ly/plotly-geo-1.52.2.min.js |
npm package (starting in v1.39.0
)
Install plotly.js-geo-dist
with
npm install plotly.js-geo-dist
ES6 module usage:
import Plotly from 'plotly.js-geo-dist'
CommonJS usage:
var Plotly = require('plotly.js-geo-dist');
dist min npm package (starting in v1.50.0
)
Install plotly.js-geo-dist-min
with
npm install plotly.js-geo-dist-min
Other plotly.js entry points
Flavor | Location |
---|---|
dist bundle | dist/plotly-geo.js |
dist bundle (minified) | dist/plotly-geo.min.js |
ES6 module | import Plotly from 'plotly.js/lib/index-geo' |
CommonJS | require('plotly.js/lib/index-geo') |
plotly.js gl3d
The gl3d
partial bundle contains trace modules scatter
, scatter3d
, surface
, mesh3d
, isosurface
, volume
, cone
and streamtube
.
Stats
Raw size | Minified size | Minified + gzip size |
---|---|---|
3.5 MB | 1.4 MB | 438.9 kB |
CDN links
Flavor | URL |
---|---|
Latest | https://cdn.plot.ly/plotly-gl3d-latest.js |
Latest minified | https://cdn.plot.ly/plotly-gl3d-latest.min.js |
Tagged | https://cdn.plot.ly/plotly-gl3d-1.52.2.js |
Tagged minified | https://cdn.plot.ly/plotly-gl3d-1.52.2.min.js |
npm package (starting in v1.39.0
)
Install plotly.js-gl3d-dist
with
npm install plotly.js-gl3d-dist
ES6 module usage:
import Plotly from 'plotly.js-gl3d-dist'
CommonJS usage:
var Plotly = require('plotly.js-gl3d-dist');
dist min npm package (starting in v1.50.0
)
Install plotly.js-gl3d-dist-min
with
npm install plotly.js-gl3d-dist-min
Other plotly.js entry points
Flavor | Location |
---|---|
dist bundle | dist/plotly-gl3d.js |
dist bundle (minified) | dist/plotly-gl3d.min.js |
ES6 module | import Plotly from 'plotly.js/lib/index-gl3d' |
CommonJS | require('plotly.js/lib/index-gl3d') |
plotly.js gl2d
The gl2d
partial bundle contains trace modules scatter
, scattergl
, splom
, pointcloud
, heatmapgl
, contourgl
and parcoords
.
Stats
Raw size | Minified size | Minified + gzip size |
---|---|---|
3.5 MB | 1.4 MB | 458.2 kB |
CDN links
Flavor | URL |
---|---|
Latest | https://cdn.plot.ly/plotly-gl2d-latest.js |
Latest minified | https://cdn.plot.ly/plotly-gl2d-latest.min.js |
Tagged | https://cdn.plot.ly/plotly-gl2d-1.52.2.js |
Tagged minified | https://cdn.plot.ly/plotly-gl2d-1.52.2.min.js |
npm package (starting in v1.39.0
)
Install plotly.js-gl2d-dist
with
npm install plotly.js-gl2d-dist
ES6 module usage:
import Plotly from 'plotly.js-gl2d-dist'
CommonJS usage:
var Plotly = require('plotly.js-gl2d-dist');
dist min npm package (starting in v1.50.0
)
Install plotly.js-gl2d-dist-min
with
npm install plotly.js-gl2d-dist-min
Other plotly.js entry points
Flavor | Location |
---|---|
dist bundle | dist/plotly-gl2d.js |
dist bundle (minified) | dist/plotly-gl2d.min.js |
ES6 module | import Plotly from 'plotly.js/lib/index-gl2d' |
CommonJS | require('plotly.js/lib/index-gl2d') |
plotly.js mapbox
The mapbox
partial bundle contains trace modules scatter
, scattermapbox
, choroplethmapbox
and densitymapbox
.
Stats
Raw size | Minified size | Minified + gzip size |
---|---|---|
3.1 MB | 1.5 MB | 461.8 kB |
CDN links
Flavor | URL |
---|---|
Latest | https://cdn.plot.ly/plotly-mapbox-latest.js |
Latest minified | https://cdn.plot.ly/plotly-mapbox-latest.min.js |
Tagged | https://cdn.plot.ly/plotly-mapbox-1.52.2.js |
Tagged minified | https://cdn.plot.ly/plotly-mapbox-1.52.2.min.js |
npm package (starting in v1.39.0
)
Install plotly.js-mapbox-dist
with
npm install plotly.js-mapbox-dist
ES6 module usage:
import Plotly from 'plotly.js-mapbox-dist'
CommonJS usage:
var Plotly = require('plotly.js-mapbox-dist');
dist min npm package (starting in v1.50.0
)
Install plotly.js-mapbox-dist-min
with
npm install plotly.js-mapbox-dist-min
Other plotly.js entry points
Flavor | Location |
---|---|
dist bundle | dist/plotly-mapbox.js |
dist bundle (minified) | dist/plotly-mapbox.min.js |
ES6 module | import Plotly from 'plotly.js/lib/index-mapbox' |
CommonJS | require('plotly.js/lib/index-mapbox') |
plotly.js finance
The finance
partial bundle contains trace modules scatter
, bar
, histogram
, pie
, funnelarea
, ohlc
, candlestick
, funnel
, waterfall
and indicator
.
Stats
Raw size | Minified size | Minified + gzip size |
---|---|---|
2.6 MB | 940.6 kB | 305.4 kB |
CDN links
Flavor | URL |
---|---|
Latest | https://cdn.plot.ly/plotly-finance-latest.js |
Latest minified | https://cdn.plot.ly/plotly-finance-latest.min.js |
Tagged | https://cdn.plot.ly/plotly-finance-1.52.2.js |
Tagged minified | https://cdn.plot.ly/plotly-finance-1.52.2.min.js |
npm package (starting in v1.39.0
)
Install plotly.js-finance-dist
with
npm install plotly.js-finance-dist
ES6 module usage:
import Plotly from 'plotly.js-finance-dist'
CommonJS usage:
var Plotly = require('plotly.js-finance-dist');
dist min npm package (starting in v1.50.0
)
Install plotly.js-finance-dist-min
with
npm install plotly.js-finance-dist-min
Other plotly.js entry points
Flavor | Location |
---|---|
dist bundle | dist/plotly-finance.js |
dist bundle (minified) | dist/plotly-finance.min.js |
ES6 module | import Plotly from 'plotly.js/lib/index-finance' |
CommonJS | require('plotly.js/lib/index-finance') |
This file is auto-generated by npm run stats
. Please do not edit this file directly.