[BUG]: 3D scatter plot randomly freezes or heavily lags after hovering in plot
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 18.3k
- Forks
- 2k
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 28
Description
Description
I'm using Python but decided to post an issue here because I tracked the issue back to the source javascript code, so please bear with this description.
I created a 3D scatter plot using the plotly.express line_3d function in Python Dash that gets updated in real time every 3 seconds. The data that gets plotted is from multiple dataframes where individual points of the same dataframe are generally very close together and linear. When I go to interact with the plot initially, everything works fine. The camera is able to rotate, pan, etc., and the hover text shows up as you would expect. However, after some amount of time (not consistent, but usually happens for me anywhere between 3-30sec of interacting with the plot), an error will trigger in the dev console and then the plot will suddenly stop allowing user interaction (this was the case when I was re-rendering the plot every update) or it will take 5+ seconds to render an interaction (this is the case when using Dash's Patch() feature to make updates to the plot). It seems to trigger from hovering over the graph regardless of if hovermode=False is set in the layout or not.
Screenshots/Video
Here is the error:
Code tracing:
I was able to trace the minified code back to the plotly.js/src/plots/gl3d/scene.js and plotly.js/src/plots/gl3d/project.js files:
Also helpful is gl-plot3d/scene.js from the gl-plot3d GitHub that shows how MouseSelect is initialized:
From what I can see, it seems like the selection variable was initialized but never set to a proper value before being used, which causes this error to be thrown & the plot to freeze up.
Steps to reproduce
- Create a Scatter3d plot populated with over 100 traces where most data points are very close (+-0.0001 or so) and linear
- Update the plot with new data every 1-5 seconds -> in my case, this includes appending data, adding new traces, and setting some existing traces to visible=False
- Make sure Pause on uncaught exceptions is set in your DevTools
- Interact with the plot while it updates, including moving the camera, zooming in, and hovering over the traces quickly for up to 30 seconds
Notes
Side note: I realized that the var pdata = project(scene.glplot.cameraParams, selection.dataCoordinate) line is declared outside of the if(scene.fullSceneLayout.hovermode) check but only used within the Fx.loneHover call, which may be the reason why this error triggers regardless of if hovermode=False is set.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with plotly.js/src/plots/gl3d/scene.js and plotly.js/src/plots/gl3d/project.js, then inspect how selection is initialized in the referenced gl-plot3d/scene.js. Run the described frequently updated Scatter3d reproduction while hovering and moving the camera. Done means interaction remains responsive and no uncaught selection or projection error occurs, including with hovermode disabled.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- data-visualization
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 66/100