plotly / plotly/plotly.js

Plotly.react doesn't transition correctly when only annotations are changed

Open
#4,839 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug P3
Dominant language
JavaScript
Stars
18.3k
Forks
2k
Avg merge
2d 12h
Merged PRs (30d)
28

Description

Here's an example where I'm attempting to transition to a plot with added annotations using Plotly.react. Notice if I update just the layout and not the data, the graph won't update.

Example 1

However if I remove the transition in Example 1, the graph will update correctly.

And if I update the data and the layout together, then also the graph will transition correctly.

Example 2

I have been running into some difficulties with annotations moving around erratically when I try to transition between layouts using Plotly.react, and in trying to debug that noticed the above. This seems to me like a bug related to transitions.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the behavior in CodePen Examples 1 and 2 using Plotly.react, comparing layout-only updates with updates that also change data and with transitions disabled. Trace the Plotly.react transition path for annotation changes. Done means layout-only annotation updates transition and render correctly without requiring a data change.

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
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.