Merge pull request #126 from plotly/plot-refresh-fix

Update when figure changes regardless of revision

Author: dmt0

README.md

@@ -123,7 +123,7 @@ In short, this means that simply adding data points to a trace in `data` or chan
 | `layout`           | `Object`                     | `undefined`                                       | layout object (see https://plot.ly/javascript/reference/#layout)                                                                                                      |
 | `frames`           | `Array`                      | `undefined`                                       | list of frame objects (see https://plot.ly/javascript/reference/)                                                                                                     |
 | `config`           | `Object`                     | `undefined`                                       | config object (see https://plot.ly/javascript/configuration-options/)                                                                                                 |
-| `revision`         | `Number`                     | `undefined`                                       | When provided, causes the plot to update _only_ when the revision is incremented.                                                                                     |
+| `revision`         | `Number`                     | `undefined`                                       | When provided, causes the plot to update when the revision is incremented.                                                                                     |
 | `onInitialized`    | `Function(figure, graphDiv)` | `undefined`                                       | Callback executed after plot is initialized. See below for parameter information.                                                                                     |
 | `onUpdate`         | `Function(figure, graphDiv)` | `undefined`                                       | Callback executed when when a plot is updated due to new data or layout, or when user interacts with a plot. See below for parameter information.                     |
 | `onPurge`          | `Function(figure, graphDiv)` | `undefined`                                       | Callback executed when component unmounts, before `Plotly.purge` strips the `graphDiv` of all private attributes. See below for parameter information.                |

src/factory.js

@@ -103,23 +103,22 @@ export default function plotComponentFactory(Plotly) {
     UNSAFE_componentWillUpdate(nextProps) {
       this.unmounting = false;
 
-      if (nextProps.revision !== void 0 && nextProps.revision === this.props.revision) {
-        // if revision is set and unchanged, do nothing
-        return;
-      }
-
+      // frames *always* changes identity so fall back to check length only :(
       const numPrevFrames =
         this.props.frames && this.props.frames.length ? this.props.frames.length : 0;
       const numNextFrames =
         nextProps.frames && nextProps.frames.length ? nextProps.frames.length : 0;
-      if (
+
+      const figureChanged = !(
         nextProps.layout === this.props.layout &&
         nextProps.data === this.props.data &&
         nextProps.config === this.props.config &&
         numNextFrames === numPrevFrames
-      ) {
-        // prevent infinite loops when component is re-rendered after onUpdate
-        // frames *always* changes identity so fall back to check length only :(
+      );
+      const revisionDefined = nextProps.revision !== void 0;
+      const revisionChanged = nextProps.revision !== this.props.revision;
+
+      if (!figureChanged && (!revisionDefined || (revisionDefined && !revisionChanged))) {
         return;
       }