plotly.js README

The project's README from github.com/plotly/plotly.js. As one markdown file: README.md.

npm version CI MIT License

Plotly.js is a standalone JavaScript data visualization library, and it also powers the Python and R modules named plotly in those respective ecosystems (referred to as Plotly.py and Plotly.R).

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.

Maintained by Plotly

Table of contents

Load as a node module

Install a ready-to-use distributed bundle

npm i --save plotly.js-dist-min

and use import or require in node.js

// ES6 module
import Plotly from 'plotly.js-dist-min'

// CommonJS
var Plotly = require('plotly.js-dist-min')

You may also consider using plotly.js-dist if you prefer using an unminified package.

Load via script tag

The script HTML element

In the examples below, the Plotly object is added to the window scope by the script tag. The newPlot method is then used to draw an interactive figure as described by data and layout into the desired div here named gd. As demonstrated in the example above, basic knowledge of HTML and JSON syntax is enough to get started, i.e., with or without JavaScript! To learn and build more with plotly.js, please visit the plotly.js documentation.

<head>
    <script src="https://cdn.plot.ly/plotly-4.1.0.min.js" charset="utf-8"></script>
</head>
<body>
    <div id="gd"></div>

    <script>
        Plotly.newPlot("gd", /* JSON object */ {
            "data": [{ "y": [1, 2, 3] }],
            "layout": { "width": 600, "height": 400}
        })
    </script>
</body>

Alternatively, you may consider using native ES6 import in the script tag.

<script type="module">
    import "https://cdn.plot.ly/plotly-4.1.0.min.js"
    Plotly.newPlot("gd", [{ y: [1, 2, 3] }])
</script>

Fastly supports Plotly.js with free CDN service. Read more at https://www.fastly.com/open-source.

Un-minified versions are also available on CDN

While non-minified source files may contain characters outside UTF-8, it is recommended that you specify the charset when loading those bundles.

<script src="https://cdn.plot.ly/plotly-4.1.0.js" charset="utf-8"></script>

Please note that as of v2 the "plotly-latest" outputs (e.g. https://cdn.plot.ly/plotly-latest.min.js) will no longer be updated on the CDN, and will stay at the last v1 patch v1.58.5. Therefore, to use the CDN with plotly.js v2 and higher, you must specify an exact plotly.js version.

MathJax

plotly.js supports using MathJax v3 or v4 to render mathematical expressions within plots.

MathJax is not included in the plotly.js bundle, so it must be loaded separately as a script on the webpage.

For MathJax v4:

<script src="https://cdn.jsdelivr.net/npm/[email protected]/tex-svg.js"></script>

For MathJax v3:

<script src="https://cdn.jsdelivr.net/npm/[email protected]/es5/tex-svg.js"></script>

When MathJax is available, any string contained within $..$ signs will be rendered using the MathJax engine. This applies to plot titles, axis labels, tick label text, and annotations.

plotly.js's use of the MathJax svg renderer should not prevent using other MathJax renderers elsewhere on the page, nor will it affect the global MathJax config. See devtools/test_dashboard/index-mathjax3chtml.html for an example of a webpage which uses the MathJax chtml renderer in the main page, and also displays Plotly charts containing MathJax equations rendered as svg.

Need to have several WebGL graphs on a page?

You may simply load the virtual-webgl script for WebGL 1 (not WebGL 2) before loading other scripts.

<script src="https://unpkg.com/[email protected]/src/virtual-webgl.js"></script>

Bundles

There are two kinds of plotly.js bundles:

  1. Complete and partial official bundles that are distributed to npm and the CDN, described in the dist README.
  2. Custom bundles you can create yourself to optimize the size of the bundle depending on your needs. Please visit CUSTOM_BUNDLE for more information.

Alternative ways to load and build plotly.js

If your library needs to bundle or directly load plotly.js/lib/index.js or parts of its modules similar to index-basic in some other way than via an official or a custom bundle, or in case you want to tweak the default build configurations, then please visit BUILDING.md.

Documentation

Official plotly.js documentation is hosted at https://plotly.com/javascript.

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.

Bugs and feature requests

Have a bug or a feature request? Please open a Github issue keeping in mind the issue guidelines. You may also want to read about how changes get made to 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.

Notable contributors

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:

Contributor GitHub Status
Alex C. Johnson @alexcjohnson Active, Maintainer
Emily Kellison-Linn @emilykl Active, Maintainer
Cameron DeCoster @camdecoster Active, Maintainer
Mojtaba Samimi @archmoj Active, Community Contributor
My-Tien Nguyen @my-tien Active, Community Contributor
Birk Skyum @birkskyum Active, Community Contributor
Étienne Tétreault-Pinard @etpinard Hall of Fame
Antoine Roy-Gobeil @antoinerg Hall of Fame
Jack Parmer @jackparmer Hall of Fame
Nicolas Kruchten @nicolaskruchten Hall of Fame
Mikola Lysenko @mikolalysenko Hall of Fame
Ricky Reusser @rreusser Hall of Fame
Dmitry Yv. @dy Hall of Fame
Jon Mease @jonmmease Hall of Fame
Robert Monfera @monfera Hall of Fame
Robert Möstl @rmoestl Hall of Fame
Nicolas Riesco @n-riesco Hall of Fame
Miklós Tusz @mdtusz Hall of Fame
Chelsea Douglas @cldougl Hall of Fame
Ben Postlethwaite @bpostlethwaite Hall of Fame
Hannah Ker @hannahker Hall of Fame
Chris Parmer @chriddyp Hall of Fame
Alex Vados @alexander-daniel Hall of Fame

Code and documentation copyright 2025 Plotly, Inc.

Code released under the MIT license.

Versioning

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.

Community

plotly.js (plotly/plotly.js)

Searching Database…

18.4K ·GitHub
Plotly.js
Что это такое?Plotly.js — это открытая JavaScript-библиотека графиков, которая рисует интерактивные диаграммы прямо в браузере. Она также лежит в основе модулей plotly для Python и R (Plotly.py, Plotly.R) и стоит за Plotly и Dash.
То есть это не приложение, которое я запускаю, а библиотека, которую я вызываю со своей веб-страницы?Именно так: вы подключаете её к странице и вызываете Plotly.newPlot, передавая объекты data и layout, чтобы нарисовать интерактивный график внутри div; никакого отдельного приложения запускать не нужно.
Как подключить её к веб-странице?Два способа: установить пакет через npm и использовать import или require в node.js, либо добавить тег script, который положит Plotly в window. Fastly раздаёт сборки через бесплатный CDN.
Нужно ли хорошо знать JavaScript, чтобы построить первый график?Не обязательно: согласно README, для старта достаточно базовых знаний HTML и синтаксиса JSON — с JavaScript или без него; график — это просто объекты data и layout.
Есть ли подводные камни, если грузить её с CDN?Да — начиная с v2 сборки 'plotly-latest' на CDN заморожены на версии v1.58.5. Для plotly.js v2 и выше в URL нужно указывать точную версию.
Можно ли пользоваться бесплатно, в том числе в коммерческих проектах?Да. Код и документация распространяются по лицензии MIT (правообладатель Plotly, Inc.), так что коммерческое использование разрешено.
Какие виды диаграмм она умеет рисовать?Десятки типов диаграмм и визуализаций: статистические графики, 3D-графики, научные диаграммы, SVG-карты и тайловые карты, финансовые графики и не только.
Полная сборка тяжёлая — можно поставить на страницу только нужные мне типы диаграмм?Да. Официальные полные и частичные сборки есть на npm и на CDN, а ещё можно собрать собственный бандл, включив только то, что использует ваше приложение, и тем самым уменьшить размер файла.
Можно ли выводить математические формулы в заголовках и подписях осей?Да — подключите на страницу MathJax v3 или v4 отдельно, и любая строка, обёрнутая в знаки $..$, будет отрисована MathJax в заголовках графиков, подписях осей, метках делений и аннотациях.
Может ли одна страница показывать сразу несколько WebGL-графиков?Да — подключите скрипт virtual-webgl (для WebGL 1, не WebGL 2) раньше остальных скриптов, и несколько WebGL-графиков смогут уживаться на одной странице.
What are similar projects?plotly.py, d3, G2, victory, flint-chart, vega, aetherviz-master, echarts
Which topics is it in?plotly, d3, charting-library, charts, webgl, svg, visualization, graphics, 3d, data-visualization, javascript-library, data-science
Creator
plotly
Size
2.1 GB
Stars
18.4K
Updated
CommitOct 15Releasev4.1.2Oct 05
Age
10y
Commits · 90 Days