Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Hook-based API #275

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.

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

Open
JamesRamm wants to merge 5 commits into plotly:master
base: master
Choose a base branch
Loading
from JamesRamm:patch-1
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
4 changes: 3 additions & 1 deletion package.json
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,9 @@
},
"peerDependencies": {
"plotly.js": ">1.34.0",
"react": ">0.13.0"
"react": ">0.13.0",
"flyd": ">0.2.8",
"ramda": ">0.28.0"
},
"browserify-global-shim": {
"react": "React"
Expand Down
50 changes: 50 additions & 0 deletions src/usePlotly.js
View file Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
import { useLayoutEffect, useState, useMemo } from 'react';
import { head, prop, compose, pick, objOf, mergeDeepRight } from 'ramda';
import { stream, scan } from 'flyd';

/**
* A simple debouncing function
*/
const debounce = (fn, delay) => {
let timeout;

return function (...args) {
const functionCall = () => fn.apply(this, args);

timeout && clearTimeout(timeout);
timeout = setTimeout(functionCall, delay);
};
};

const getSizeForLayout = compose(objOf('layout'), pick(['width', 'height']), prop('contentRect'), head);

export default function usePlotly() {
const updates = useMemo(stream, []);
const appendData = useMemo(stream, []);
const plotlyState = useMemo(
() => scan(mergeDeepRight, { data: [], config: {}, layout: {} }, updates),
[]
Copy link

@terebentina terebentina Oct 13, 2022

Choose a reason for hiding this comment

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

Shouldn't updates be added to the dependencies list here since it's used inside the hook?

Copy link
Author

@JamesRamm JamesRamm Oct 14, 2022

Choose a reason for hiding this comment

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

since updates is memoized with an empty array, it will only be computed once on mount, so adding it to the dependencies array or not for plotlyState will have no effect....

);

const observer = new ResizeObserver(debounce(compose(updates, getSizeForLayout), 100));
const [internalRef, setRef] = useState(null);
useLayoutEffect(() => {
if (internalRef) {
observer.observe(internalRef);
const endS = plotlyState.map(state => {
Plotly.react(internalRef, state);
});

const endAppend = appendData.map(({ data, tracePos }) => Plotly.extendTraces(internalRef, data, tracePos));
Copy link
Collaborator

@alexcjohnson alexcjohnson Oct 13, 2022

Choose a reason for hiding this comment

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

Since you've implemented extendTraces here, let's finish it by including maxPoints (the optional 4th argument to extendTraces)

JamesRamm reacted with thumbs up emoji

return () => {
Plotly.purge(internalRef);
observer.unobserve(internalRef);
endAppend.end(true);
endS.end(true);
};
}
}, [internalRef, plotlyState, updates, appendData]);
Copy link

@terebentina terebentina Oct 13, 2022

Choose a reason for hiding this comment

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

Shouldn't observer be added as a dependency here since it's used inside the hook?

nlappas reacted with thumbs up emoji

return { ref: setRef, updates, appendData };
}

AltStyle によって変換されたページ (->オリジナル) /