You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -75,7 +75,6 @@ test dashboard, inspect and debug the changes, then repeat. The test dashboard
75
75
comes bundled with some useful tools while developing - all bundled under the
76
76
`Tabs` object:
77
77
78
-
79
78
| Method/Property | Description |
80
79
|------------------------|-------------|
81
80
|`Tabs.fresh([id])`| Creates a fresh graph div and returns it (default id of `graph`). |
@@ -101,8 +100,8 @@ image mocks based on their file name and trace type.
101
100
102
101
Use the [`plotly-mock-viewer`](https://github.com/rreusser/plotly-mock-viewer)
103
102
which has live-reloading and a bunch of other cool features.
104
-
An online version of `plotly-mock-viewer` is available at https://rreusser.github.io/plotly-mock-viewer/
105
-
which uses https://cdn.plot.ly/plotly-latest.min.js
103
+
An online version of `plotly-mock-viewer` is available at <https://rreusser.github.io/plotly-mock-viewer/>
104
+
which uses <https://cdn.plot.ly/plotly-latest.min.js>
106
105
107
106
#### Other npm scripts
108
107
@@ -179,6 +178,7 @@ To view the image pixel comparison test results, run
179
178
```
180
179
npm run start-image_viewer
181
180
```
181
+
182
182
which shows the baseline image, the generated image, the diff and the json mocks of test cases that failed.
183
183
184
184
To view the results of a run on CircleCI, download the `build/test_images/` and `build/test_images_diff/` artifacts into your local repo and then run `npm run start-image_viewer`.
@@ -196,7 +196,7 @@ To view the results of a run on CircleCI, download the `build/test_images/` and
196
196
197
197
### Writing jasmine interaction tests
198
198
199
-
Keep in mind that the interaction coordinates are relative to the top-left corner of the plot, including the margins. To produce a reliable interaction test,
199
+
Keep in mind that the interaction coordinates are relative to the top-left corner of the plot, including the margins. To produce a reliable interaction test,
200
200
it may be necessary to fix the width, height, margins, X axis range and Y axis range of the plot. For example:
[Contact us](https://plotly.com/products/consulting-and-oem/) for Plotly.js consulting, dashboard development, application integration, and feature additions.
18
19
@@ -29,7 +30,6 @@ and more.
29
30
*[Creators](#creators)
30
31
*[Copyright and license](#copyright-and-license)
31
32
32
-
33
33
## Quick start options
34
34
35
35
### Install with npm
@@ -38,7 +38,8 @@ and more.
38
38
npm install plotly.js-dist
39
39
```
40
40
41
-
and import plotly.js as
41
+
and import plotly.js as
42
+
42
43
```js
43
44
importPlotlyfrom'plotly.js-dist'
44
45
// Or using require,
@@ -60,7 +61,7 @@ var Plotly = require('plotly.js-dist')
60
61
61
62
and use the `Plotly` object in the window scope.
62
63
63
-
Fastly supports Plotly.js with free CDN service. Read more at https://www.fastly.com/open-source
64
+
Fastly supports Plotly.js with free CDN service. Read more at <https://www.fastly.com/open-source>
64
65
65
66
### Download the latest release
66
67
@@ -70,7 +71,6 @@ and use the plotly.js `dist` file(s). More info [here](https://github.com/plotly
70
71
71
72
#### Read the [Getting started page](https://plotly.com/javascript/getting-started/) for more examples.
72
73
73
-
74
74
## Modules
75
75
76
76
Starting in `v1.15.0`, plotly.js ships with several _partial_ bundles (more info [here](https://github.com/plotly/plotly.js/blob/master/dist/README.md#partial-bundles)).
@@ -149,6 +149,7 @@ Open-source clients to the plotly.js APIs are available at these links:
0 commit comments