8000 Update README.md · kb-/plotly.js@d69ac85 · GitHub
[go: up one dir, main page]
Skip to content

Commit d69ac85

Browse files
kb-kb-
authored
Update README.md
1 parent fcd8457 commit d69ac85

File tree

1 file changed

+5
-153
lines changed

1 file changed

+5
-153
lines changed

‎README.md

Lines changed: 5 additions & 153 deletions
Original file line numberDiff line numberDiff line change
@@ -4,162 +4,14 @@
44
[![circle ci](https://circleci.com/gh/plotly/plotly.js.png?&style=shield&circle-token=1f42a03b242bd969756fc3e53ede204af9b507c0)](https://circleci.com/gh/plotly/plotly.js)
55
[![MIT License](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://github.com/plotly/plotly.js/blob/master/LICENSE)
66

7-
[Plotly.js](https://plotly.com/javascript) 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](https://plotly.com/python) and [Plotly.R](http://plotly.com/r)).
7+
This branch introduces a tooltip feature and modebar button. It allows to add an annotation to every clicked point.
8+
When a plot is created with `editable: true`, the tooltips can be dragged around or deleted.
9+
To delete a tooltip, click on its text and delete it.
810

9-
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.
11+
tooltips can be customized with an optional `tooltiptemplate` (possibilities equivalent to [hovertemplate](https://plotly.com/javascript/reference/scatter/#scatter-hovertemplate)) and `tooltip` annotation options (possibilities equivalent to [annotations](https://plotly.com/javascript/text-and-annotations/))
12+
![image](https://github.com/kb-/plotly.js/assets/2260417/f7258b47-6eb2-4c3c-a3ce-f23899fe57e1)
1013

11-
<p align="center">
12-
<a href="https://plotly.com/javascript/" target="_blank">
13-
<img src="https://raw.githubusercontent.com/cldougl/plot_images/add_r_img/plotly_2017.png">
14-
</a>
15-
</p>
1614

17-
[Contact us](https://plotly.com/products/consulting-and-oem/) for Plotly.js consulting, dashboard development, application integration, and feature additions.
18-
19-
## Table of contents
20-
21-
* [Load as a node module](#load-as-a-node-module)
22-
* [Load via script tag](#load-via-script-tag)
23-
* [Bundles](#bundles)
24-
* [Alternative ways to load and build plotly.js](#alternative-ways-to-load-and-build-plotlyjs)
25-
* [Documentation](#documentation)
26-
* [Bugs and feature requests](#bugs-and-feature-requests)
27-
* [Contributing](#contributing)
28-
* [Notable contributors](#notable-contributors)
29-
* [Copyright and license](#copyright-and-license)
30-
* [Community](#community)
31-
32-
---
33-
## Load as a node module
34-
Install [a ready-to-use distributed bundle](https://github.com/plotly/plotly.js/blob/master/dist/README.md)
35-
```sh
36-
npm i --save plotly.js-dist-min
37-
```
38-
39-
and use import or require in node.js
40-
```js
41-
// ES6 module
42-
import Plotly from 'plotly.js-dist-min'
43-
44-
// CommonJS
45-
var Plotly = require('plotly.js-dist-min')
46-
```
47-
48-
You may also consider using [`plotly.js-dist`](https://www.npmjs.com/package/plotly.js-dist) if you prefer using an unminified package.
49-
50-
---
51-
## Load via script tag
52-
53-
### The script HTML element
54-
> In the examples below `Plotly` object is added to the window scope by `script`. 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](https://en.wikipedia.org/wiki/JSON) syntax is enough to get started i.e. with/without JavaScript! To learn and build more with plotly.js please visit [plotly.js documentation](https://plotly.com/javascript).
55-
56-
```html
57-
<head>
58-
<script src="https://cdn.plot.ly/plotly-2.32.0.min.js" charset="utf-8"></script>
59-
</head>
60-
<body>
61-
<div id="gd"></div>
62-
63-
<script>
64-
Plotly.newPlot("gd", /* JSON object */ {
65-
"data": [{ "y": [1, 2, 3] }],
66-
"layout": { "width": 600, "height": 400}
67-
})
68-
</script>
69-
</body>
70-
```
71-
72-
Alternatively you may consider using [native ES6 import](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) in the script tag.
73-
```html
74-
<script type="module">
75-
import "https://cdn.plot.ly/plotly-2.32.0.min.js"
76-
Plotly.newPlot("gd", [{ y: [1, 2, 3] }])
77-
</script>
78-
```
79-
80-
Fastly supports Plotly.js with free CDN service. Read more at <https://www.fastly.com/open-source>.
81-
82-
### Un-minified versions are also available on CDN
83-
While non-minified source files may contain characters outside UTF-8, it is recommended that you specify the `charset` when loading those bundles.
84-
```html
85-
<script src="https://cdn.plot.ly/plotly-2.32.0.js" charset="utf-8"></script>
86-
```
87-
88-
> 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.
89-
90-
### MathJax
91-
You could load either version two or version three of MathJax files, for example:
92-
```html
93-
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-AMS-MML_SVG.js"></script>
94-
```
95-
96-
```html
97-
<script src="https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/tex-svg.js"></script>
98-
```
99-
100-
> When using MathJax version 3, it is also possible to use `chtml` output on the other parts of the page in addition to `svg` output for the plotly graph.
101-
Please refer to `devtools/test_dashboard/index-mathjax3chtml.html` to see an example.
102-
103-
### Need to have several WebGL graphs on a page?
104-
You may simply load [virtual-webgl](https://github.com/greggman/virtual-webgl) script for WebGL 1 (not WebGL 2) before loading other scripts.
105-
```html
106-
<script src="https://unpkg.com/virtual-webgl@1.0.6/src/virtual-webgl.js"></script>
107-
```
108-
109-
## Bundles
110-
There are two kinds of plotly.js bundles:
111-
1. Complete and partial official bundles that are distributed to `npm` and the `CDN`, described in [the dist README](https://github.com/plotly/plotly.js/blob/master/dist/README.md).
112-
2. Custom bundles you can create yourself to optimize the size of bundle depending on your needs. Please visit [CUSTOM_BUNDLE](https://github.com/plotly/plotly.js/blob/master/CUSTOM_BUNDLE.md) for more information.
113-
114-
---
115-
## Alternative ways to load and build plotly.js
116-
If your library needs to bundle or directly load [plotly.js/lib/index.js](https://github.com/plotly/plotly.js/blob/master/lib/index.js) or parts of its modules similar to [index-basic](https://github.com/plotly/plotly.js/blob/master/lib/index-basic.js) 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`](https://github.com/plotly/plotly.js/blob/master/BUILDING.md).
117-
118-
---
119-
## Documentation
120-
121-
Official plotly.js documentation is hosted at [https://plotly.com/javascript](https://plotly.com/javascript).
122-
123-
These pages are generated by the Plotly [graphing-library-docs repo](https://github.com/plotly/graphing-library-docs) built with [Jekyll](https://jekyllrb.com/) and publicly hosted on GitHub Pages.
124-
For more info about contributing to Plotly documentation, please read through [contributing guidelines](https://github.com/plotly/graphing-library-docs/blob/master/README.md).
125-
126-
---
127-
## Bugs and feature requests
128-
129-
Have a bug or a feature request? Please [open a Github issue](https://github.com/plotly/plotly.js/issues/new) keeping in mind the [issue guidelines](https://github.com/plotly/plotly.js/blob/master/.github/ISSUE_TEMPLATE.md). You may also want to read about [how changes get made to Plotly.js](https://github.com/plotly/plotly.js/blob/master/CONTRIBUTING.md)
130-
131-
---
132-
## Contributing
133-
134-
Please read through our [contributing guidelines](https://github.com/plotly/plotly.js/blob/master/CONTRIBUTING.md). Included are directions for opening issues, using plotly.js in your project and notes on development.
135-
136-
---
137-
## Notable contributors
138-
139-
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:
140-
141-
| | GitHub | Twitter | Status |
142-
|---|--------|---------|--------|
143-
|**Alex C. Johnson**| [@alexcjohnson](https://github.com/alexcjohnson) | | Active, Maintainer |
144-
|**Mojtaba Samimi** | [@archmoj](https://github.com/archmoj) | [@solarchvision](https://twitter.com/solarchvision) | Active, Maintainer |
145-
|**Antoine Roy-Gobeil** | [@antoinerg](https://github.com/antoinerg) | | Active, Maintainer |
146-
|**Emily Kellison-Linn** | [@emilykl](https://github.com/emilykl) | | Active, Maintainer |
147-
|**Hannah Ker** | [@hannahker](https://github.com/hannahker) | [@hannahker11](https://twitter.com/hannahker11)| Active, Maintainer |
148-
|**Étienne Tétreault-Pinard**| [@etpinard](https://github.com/etpinard) | [@etpinard](https://twitter.com/etpinard) | Hall of Fame |
149-
|**Nicolas Kruchten** | [@nicolaskruchten](https://github.com/nicolaskruchten) | [@nicolaskruchten](https://twitter.com/nicolaskruchten) | Hall of Fame |
150-
|**Jon Mease** | [@jonmmease](https://github.com/jonmmease) | [@jonmmease](https://twitter.com/jonmmease) | Hall of Fame |
151-
|**Mikola Lysenko**| [@mikolalysenko](https://github.com/mikolalysenko) | [@MikolaLysenko](https://twitter.com/MikolaLysenko) | Hall of Fame |
152-
|**Ricky Reusser**| [@rreusser](https://github.com/rreusser) | [@rickyreusser](https://twitter.com/rickyreusser) | Hall of Fame |
153-
|**Dmitry Yv.** | [@dy](https://github.com/dy) | [@DimaYv](https://twitter.com/dimayv)| Hall of Fame |
154-
|**Robert Monfera**| [@monfera](https://github.com/monfera) | [@monfera](https://twitter.com/monfera) | Hall of Fame |
155-
|**Robert Möstl** | [@rmoestl](https://github.com/rmoestl) | [@rmoestl](https://twitter.com/rmoestl) | Hall of Fame |
156-
|**Nicolas Riesco**| [@n-riesco](https://github.com/n-riesco) | | Hall of Fame |
157-
|**Miklós Tusz**| [@mdtusz](https://github.com/mdtusz) | [@mdtusz](https://twitter.com/mdtusz)| Hall of Fame |
158-
|**Chelsea Douglas**| [@cldougl](https://github.com/cldougl) | | Hall of Fame |
159-
|**Ben Postlethwaite**| [@bpostlethwaite](https://github.com/bpostlethwaite) | | Hall of Fame |
160-
|**Jack Parmer**| [@jackparmer](https://github.com/jackparmer) | | Hall of Fame |
161-
|**Chris Parmer**| [@chriddyp](https://github.com/chriddyp) | | Hall of Fame |
162-
|**Alex Vados**| [@alexander-daniel](https://github.com/alexander-daniel) | | Hall of Fame |
16315

16416
---
16517
## Copyright and license

0 commit comments

Comments
 (0)
0