Skip to content

various fixes for event addition/removal #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 20, 2018
Merged

various fixes for event addition/removal #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 0 additions & 26 deletions src/__tests__/react-plotly.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,32 +135,6 @@ describe('<Plotly/>', () => {
.catch(err => done.fail(err));
});

test('clear event handlers on newPlot', done => {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this test was way too implementation-specific and now depends on the Plotly.js version.

let wrapper;
createPlot({
fit: false,
onClick: jest.fn(),
onUpdate: once(() => {
expect(
wrapper.instance().clearLocalEventHandlers
).toHaveBeenCalled();
done();
}),
})
.then(plot => {
wrapper = plot;

// make sure real clearLocalEventHandlers does the job
expect(Object.keys(wrapper.instance().handlers)).toEqual(['Click']);
plot.instance().clearLocalEventHandlers();
expect(Object.keys(wrapper.instance().handlers)).toEqual([]);

plot.instance().clearLocalEventHandlers = jest.fn();
plot.setProps({layout: {title: 'test test'}});
})
.catch(err => done.fail(err));
});

test('revision counter', done => {
var callCnt = 0;
createPlot({
Expand Down
57 changes: 24 additions & 33 deletions src/factory.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ import React, {Component} from 'react';
import PropTypes from 'prop-types';
import isNumeric from 'fast-isnumeric';
import objectAssign from 'object-assign';
// import throttle from "throttle-debounce/throttle";

// The naming convention is:
// - events are attached as `'plotly_' + eventName.toLowerCase()`
Expand Down Expand Up @@ -56,14 +55,13 @@ export default function plotComponentFactory(Plotly) {

this.p = Promise.resolve();
this.fitHandler = null;
this.resizeHandler = null;
this.handlers = {};

this.syncWindowResize = this.syncWindowResize.bind(this);
this.syncEventHandlers = this.syncEventHandlers.bind(this);
this.attachUpdateEvents = this.attachUpdateEvents.bind(this);
this.getRef = this.getRef.bind(this);

//this.handleUpdate = throttle(0, this.handleUpdate.bind(this));
this.handleUpdate = this.handleUpdate.bind(this);
}

Expand All @@ -79,7 +77,7 @@ export default function plotComponentFactory(Plotly) {
.then(() => {
return Plotly.newPlot(this.el, {
data: this.props.data,
layout: this.sizeAdjustedLayout(this.props.layout),
layout: this.resizedLayoutIfFit(this.props.layout),
config: this.props.config,
frames: this.props.frames,
});
Expand All @@ -97,30 +95,30 @@ export default function plotComponentFactory(Plotly) {
}

componentWillUpdate(nextProps) {
let nextLayout = this.sizeAdjustedLayout(nextProps.layout);

this.p = this.p
.then(() => {
if (hasReactAPIMethod) {
return Plotly.react(this.el, {
data: nextProps.data,
layout: nextLayout,
layout: this.resizedLayoutIfFit(nextProps.layout),
config: nextProps.config,
frames: nextProps.frames,
});
} else {
this.clearLocalEventHandlers();
this.handlers = {};
return Plotly.newPlot(this.el, {
data: nextProps.data,
layout: nextLayout,
layout: this.resizedLayoutIfFit(nextProps.layout),
config: nextProps.config,
frames: nextProps.frames,
});
}
})
.then(() => this.syncEventHandlers(nextProps))
.then(() => this.syncWindowResize(nextProps))
.then(this.attachUpdateEvents)
.then(() => {
if (!hasReactAPIMethod) this.attachUpdateEvents();
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is the main fix

})
.then(() => this.handleUpdate(nextProps))
.catch(err => {
console.error('Error while plotting:', err);
Expand All @@ -147,25 +145,21 @@ export default function plotComponentFactory(Plotly) {
}

attachUpdateEvents() {
if (!this.el || !this.el.removeListener) return;

for (let i = 0; i < updateEvents.length; i++) {
this.el.on(updateEvents[i], () => {
this.handleUpdate();
});
this.el.on(updateEvents[i], this.handleUpdate);
}
}

removeUpdateEvents() {
if (!this.el || !this.el.off) return;
if (!this.el || !this.el.removeListener) return;

for (let i = 0; i < updateEvents.length; i++) {
this.el.off(updateEvents[i], this.handleUpdate);
this.el.removeListener(updateEvents[i], this.handleUpdate);
}
}

clearLocalEventHandlers() {
this.handlers = [];
}

handleUpdate(props) {
props = props || this.props;
if (props.onUpdate && typeof props.onUpdate === 'function') {
Expand Down Expand Up @@ -219,11 +213,14 @@ export default function plotComponentFactory(Plotly) {
const hasHandler = !!this.handlers[eventName];

if (prop && !hasHandler) {
let handler = (this.handlers[eventName] = props['on' + eventName]);
this.el.on('plotly_' + eventName.toLowerCase(), handler);
this.handlers[eventName] = prop;
this.el.on(
'plotly_' + eventName.toLowerCase(),
this.handlers[eventName]
);
} else if (!prop && hasHandler) {
// Needs to be removed:
this.el.off(
this.el.removeListener(
'plotly_' + eventName.toLowerCase(),
this.handlers[eventName]
);
Expand All @@ -232,17 +229,11 @@ export default function plotComponentFactory(Plotly) {
}
}

sizeAdjustedLayout(layout) {
if (this.props.fit) {
layout = objectAssign({}, layout);
objectAssign(layout, this.getSize(layout));
resizedLayoutIfFit(layout) {
if (!this.props.fit) {
return layout;
}

return layout;
}

getParentSize() {
return this.el.parentElement.getBoundingClientRect();
return objectAssign({}, layout, this.getSize(layout));
}

getSize(layout) {
Expand All @@ -254,7 +245,7 @@ export default function plotComponentFactory(Plotly) {
const hasHeight = isNumeric(layoutHeight);

if (!hasWidth || !hasHeight) {
rect = this.getParentSize();
rect = this.el.parentElement.getBoundingClientRect();
}

return {
Expand Down