plotly / plotly/react-plotly.js

OnClick callback receives incomplete data when using React.SetStateAction

Offen
#358 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
JavaScript
Sterne
1.1k
Forks
138
Ø Merge
3 T. 2 Std.
Gemergte PRs (30 T.)
4

Beschreibung

I'm writing an onClick event for my Pie chart and then using data provided in event.points[index] for my needs to create a custom popover. I noticed that when I click on the pie chart slice for the first time, I receive data including the properties percent and text, and both are numbers. percent represents a decimal percentage value, and the text shows the real value

{ 
...
  percent : 0.5773337926283155,
  pointNumber: 0,
  pointNumbers: [0],
  text: 1676,
  v: 1676,
  value: 1676,
... 
}

When I click just right after that on the other pie sector, I recieve the different data structure

{ 
...
  percent : undefined,
  pointNumber: 0,
  pointNumbers: [0],
  text: '57%',
  v: 1676,
  value: 1676,
... 
}

As you can see now, percent is undefined, and text is a formatted string with a percent unit. It also missing bbox props. I do not use it by I just noticed that.

In my onClick handlers, I'm changing the state of the React component to store the clicked point. Also, I have a popover outside click event (provided by Mantine), which is basically a document click listener, and I'm resetting my stored click point.

When I don't mutate the React component state and just console.log the event points in my onClick handler, the data is consistent and always contains the property percent, and the text is a number.

It seems like the React state update in my component triggers some Plotly rerender, which breaks the logic of computing the data.

From the code of plotly.js, I noticed that you are reusing hoverData, computing it, and sending it as a callback parameter. I decided to compare onClick and onHover events parameters. Comes up that the onHover handler always receives correct data and properties percent, bbox and text is a number, but just right after click this parameters are missing in onClick event.

Here is an example in Codepen where I managed to reproduce similar issues

https://codepen.io/graylog-max/pen/myPjYZN

I this example I have:

  • onCLickHandler it stores data from points to react.useStates and logs in console percent, bbox and text
  • onHoverHandler it stores data from points to react.useStates and logs in console percent, bbox and text
  • React.useEffect, which adds document.addEventListener to somehow mock Mantine onOutsideClick which also change the state

Here are scenarios of inconsistent behaviors depending on whether in some of these cases the state update is disabled. You can do that by just commented lines setClickPoint(ev.points[0]); , setHoverPoint(ev.points[0]); or whole useEffect

  1. All three handlers do not mutate state. No matter how many times we click or hover the data is consistent
Image Image
  1. only onCLickHandler mutating the state. The first click on the slice has all data, but when we click, just right after that, on the same slice again, the data doesn't contain all fields. If before clicking on the slice again we click somewhere outside of the chart, then the click data is fine. Hover data is always fine.
Image Image Image
  1. onCLickHandler enabled mutation and useEffect or onHoverHandler as well. Then onClick data is missing bbox and percent but hover is fine
Image Image
  1. If you put the brakepoint node_modules/plotly.js/src/traces/pie/plot.js line 471 inside the function sliceTop.on('click', function(pt) then everything works fine in any scenarion. I think that proves that computed data needs more time to be completed before getting to onClick callbacks.

I can fix my initial issue just by calculating the percent by myself, but this bug might be a sign of other potential issues, so it would be nice to find a solid fix. The bug relates to React state updates, which are happening very often.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der verknüpften CodePen-Reproduktion und vergleiche die onClick- und onHover-Ereignisdaten, während React-Zustandsaktualisierungen und der document click listener aktiviert sind. Untersuche node_modules/plotly.js/src/traces/pie/plot.js um Zeile 471 und verfolge, wann der click callback seine Punktdaten erhält. Als abgeschlossen gilt die Aufgabe, wenn wiederholte Klicks nach React-Rerenders konsistent percent, bbox und den erwarteten numerischen Text enthalten.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript, react
Bereich
data-visualization, frontend
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Ruhig
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
48/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.