Skip to content

Commit 765fdb6

Browse files
archmojarchmoj
committed
plot.ly -> plotly.com
1 parent a916611 commit 765fdb6

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

‎README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
![plotly-react-logo](https://images.plot.ly/plotly-documentation/thumbnail/react.png)
44

55
> A [plotly.js](https://github.com/plotly/plotly.js) React component from
6-
> [Plotly](https://plot.ly/). The basis of Plotly's
7-
> [React component suite](https://plot.ly/products/react/).
6+
> [Plotly](https://plotly.com/). The basis of Plotly's
7+
> [React component suite](https://plotly.com/products/react/).
88
99
👉 [Demo source code](https://github.com/plotly/react-plotly.js-demo-app)
1010

@@ -66,8 +66,8 @@ You should see a plot like this:
6666

6767
For a full description of Plotly chart types and attributes see the following resources:
6868

69-
- [Plotly JavaScript API documentation](https://plot.ly/javascript/)
70-
- [Full plotly.js attribute listing](https://plot.ly/javascript/reference/)
69+
- [Plotly JavaScript API documentation](https://plotly.com/javascript/)
70+
- [Full plotly.js attribute listing](https://plotly.com/javascript/reference/)
7171

7272
## State management
7373

@@ -99,15 +99,15 @@ class App extends React.Component {
9999

100100
## Refreshing the Plot
101101

102-
This component will refresh the plot via [`Plotly.react`](https://plot.ly/javascript/plotlyjs-function-reference/#plotlyreact) if any of the following are true:
102+
This component will refresh the plot via [`Plotly.react`](https://plotly.com/javascript/plotlyjs-function-reference/#plotlyreact) if any of the following are true:
103103

104104
- The `revision` prop is defined and has changed, OR;
105105
- One of `data`, `layout` or `config` has changed identity as checked via a shallow `===`, OR;
106106
- The number of elements in `frames` has changed
107107

108-
Furthermore, when called, [`Plotly.react`](https://plot.ly/javascript/plotlyjs-function-reference/#plotlyreact) will only refresh the data being plotted if the _identity_ of the data arrays (e.g. `x`, `y`, `marker.color` etc) has changed, or if `layout.datarevision` has changed.
108+
Furthermore, when called, [`Plotly.react`](https://plotly.com/javascript/plotlyjs-function-reference/#plotlyreact) will only refresh the data being plotted if the _identity_ of the data arrays (e.g. `x`, `y`, `marker.color` etc) has changed, or if `layout.datarevision` has changed.
109109

110-
In short, this means that simply adding data points to a trace in `data` or changing a value in `layout` will not cause a plot to update unless this is done immutably via something like [immutability-helper](https://github.com/kolodny/immutability-helper) if performance considerations permit it, or unless `revision` and/or [`layout.datarevision`](https://plot.ly/javascript/reference/#layout-datarevision) are used to force a rerender.
110+
In short, this means that simply adding data points to a trace in `data` or changing a value in `layout` will not cause a plot to update unless this is done immutably via something like [immutability-helper](https://github.com/kolodny/immutability-helper) if performance considerations permit it, or unless `revision` and/or [`layout.datarevision`](https://plotly.com/javascript/reference/#layout-datarevision) are used to force a rerender.
111111

112112
## API Reference
113113

@@ -117,10 +117,10 @@ In short, this means that simply adding data points to a trace in `data` or chan
117117

118118
| Prop | Type | Default | Description |
119119
| ------------------ | ---------------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
120-
| `data` | `Array` | `[]` | list of trace objects (see https://plot.ly/javascript/reference/) |
121-
| `layout` | `Object` | `undefined` | layout object (see https://plot.ly/javascript/reference/#layout) |
122-
| `frames` | `Array` | `undefined` | list of frame objects (see https://plot.ly/javascript/reference/) |
123-
| `config` | `Object` | `undefined` | config object (see https://plot.ly/javascript/configuration-options/) |
120+
| `data` | `Array` | `[]` | list of trace objects (see https://plotly.com/javascript/reference/) |
121+
| `layout` | `Object` | `undefined` | layout object (see https://plotly.com/javascript/reference/#layout) |
122+
| `frames` | `Array` | `undefined` | list of frame objects (see https://plotly.com/javascript/reference/) |
123+
| `config` | `Object` | `undefined` | config object (see https://plotly.com/javascript/configuration-options/) |
124124
| `revision` | `Number` | `undefined` | When provided, causes the plot to update when the revision is incremented. |
125125
| `onInitialized` | `Function(figure, graphDiv)` | `undefined` | Callback executed after plot is initialized. See below for parameter information. |
126126
| `onUpdate` | `Function(figure, graphDiv)` | `undefined` | Callback executed when a plot is updated due to new data or layout, or when user interacts with a plot. See below for parameter information. |
@@ -132,7 +132,7 @@ In short, this means that simply adding data points to a trace in `data` or chan
132132
| `debug` | `Boolean` | `false` | Assign the graph div to `window.gd` for debugging |
133133
| `useResizeHandler` | `Boolean` | `false` | When true, adds a call to `Plotly.Plot.resize()` as a `window.resize` event handler |
134134

135-
**Note**: To make a plot responsive, i.e. to fill its containing element and resize when the window is resized, use `style` or `className` to set the dimensions of the element (i.e. using `width: 100%; height: 100%` or some similar values) and set `useResizeHandler` to `true` while setting `layout.autosize` to `true` and leaving `layout.height` and `layout.width` undefined. This can be seen in action in [this CodePen](https://codepen.io/nicolaskruchten/pen/ERgBZX) and will implement the behaviour documented here: https://plot.ly/javascript/responsive-fluid-layout/
135+
**Note**: To make a plot responsive, i.e. to fill its containing element and resize when the window is resized, use `style` or `className` to set the dimensions of the element (i.e. using `width: 100%; height: 100%` or some similar values) and set `useResizeHandler` to `true` while setting `layout.autosize` to `true` and leaving `layout.height` and `layout.width` undefined. This can be seen in action in [this CodePen](https://codepen.io/nicolaskruchten/pen/ERgBZX) and will implement the behaviour documented here: https://plotly.com/javascript/responsive-fluid-layout/
136136

137137
#### Callback signature: `Function(figure, graphDiv)`
138138

@@ -144,7 +144,7 @@ The `onInitialized`, `onUpdate` and `onPurge` props are all functions which will
144144

145145
### Event handler props
146146

147-
Event handlers for specific [`plotly.js` events](https://plot.ly/javascript/plotlyjs-events/) may be attached through the following props:
147+
Event handlers for specific [`plotly.js` events](https://plotly.com/javascript/plotlyjs-events/) may be attached through the following props:
148148

149149
| Prop | Type | Plotly Event |
150150
| ------------------------- | ---------- | ------------------------------ |

0 commit comments

Comments
 (0)