Scattergl (WebGL) lines are not well behaved when zoomed very close
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 18.8k
- Forks
- 2.8k
- Avg merge
- 16h 26m
- Merged PRs (30d)
- 21
Description
Plotly version 4.11.0
Plotting offline
This was discovered while working on time-series data that covers a large time span (months) but has interesting features at a very low time span (seconds). The original data was defined using pandas dataframes and timestamps but I have removed those references from my example in favor of the python built-in datetime type, though they appear to behave the same.
In the example below, fig1 and fig3 look fine, but the lines and dots in fig2 are not aligned like they should be. The issue is exaggerated with even larger time spans. Although using Scatter() in place of Scattergl() is a workaround for this issue, I would prefer to continue using Scattergl() to take advantage of the increased performance.
Other things I have noticed while investigating:
- The misalignment is only in the horizontal direction.
- The lines appear to "jitter" as the figure is scaled on the x-axis (for example, grabbing the right corner of the xaxis using the mouse and dragging it right or left).
- The issue may be hardware specific. I could not reproduce the issue on my laptop which has an intel CPU with integrated graphics. The issue was discovered on an intel CPU in a desktop using a discrete Radeon GPU.
import datetime
import plotly.graph_objects as go
# Define data:
date_format = '%Y-%m-%d %H:%M:%S'
dates = ['2020-11-01 0:0:0', '2020-11-01 0:0:1', '2020-11-01 0:0:2', '2020-11-01 0:0:3', '2020-11-01 0:0:4', '2020-11-01 0:0:5']
xvals = [datetime.datetime.strptime(this_date, date_format) for this_date in dates]
yvals = [0, 2, 0, 5, 0]
# Add one value on to the start of the data that is far away from the rest of the data
xvals_stretched = [datetime.datetime.strptime('2020-06-01 0:0:0', date_format)] + xvals
yvals_stretched = [0] + yvals
# Set the initial zoom to show the interesting part of the data
x_window_left = datetime.datetime(2020, 10, 31, 23, 59, 55)
x_window_right = datetime.datetime(2020, 11, 1, 0, 0, 10)
# %% A simple plot that works fine with Scattergl
fig1 = go.Figure()
trace = go.Scattergl(x=xvals, y=yvals)
fig1.add_trace(trace)
fig1.update_layout(title=f'fig1: WebGL (time span: {xvals[-1] - xvals[0]})')
fig1.update_xaxes(range=[x_window_left, x_window_right])
fig1.show(renderer='browser')
# %% The same simple plot with one extra datapoint that is far away on the x-axis
fig2 = go.Figure()
trace = go.Scattergl(x=xvals_stretched, y=yvals_stretched)
fig2.add_trace(trace)
fig2.update_layout(title=f'fig2: WebGL (time span: {xvals_stretched[-1] - xvals_stretched[0]})')
fig2.update_xaxes(range=[x_window_left, x_window_right])
fig2.show(renderer='browser')
# %% The stretched plot but without using Scattergl
fig3 = go.Figure()
trace = go.Scatter(x=xvals_stretched, y=yvals_stretched)
fig3.add_trace(trace)
fig3.update_layout(title=f'fig3: SVG (time span: {xvals_stretched[-1] - xvals_stretched[0]})')
fig3.update_xaxes(range=[x_window_left, x_window_right])
fig3.show(renderer='browser')
Running this code should produce three figures illustrating the issue:



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
Run the supplied Python reproducer with the three figures and compare the Scattergl and Scatter results while zooming the x-axis. Trace the Scattergl rendering path for datetime data with a distant x-value; done means the lines and markers remain horizontally aligned and stable when zoomed and rescaled, without losing the performance benefits of Scattergl.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data-visualization
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100