plotly / plotly/react-plotly.js
OnClick callback receives incomplete data when using React.SetStateAction
還沒有人認領這個 Issue。
- 主要語言
- JavaScript
- 星號
- 1.1k
- 分支
- 138
- 平均合併
- 3 天 2 小時
- 30 天內合併 PR
- 4
描述
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
- All three handlers do not mutate state. No matter how many times we click or hover the data is consistent
- 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.
- onCLickHandler enabled mutation and useEffect or onHoverHandler as well. Then onClick data is missing bbox and percent but hover is fine
- If you put the brakepoint
node_modules/plotly.js/src/traces/pie/plot.jsline 471 inside the functionsliceTop.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.
貢獻指南
這個儲存庫沒有索引到貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
從連結的 CodePen 重現開始,在啟用 React 狀態更新和 document click listener 的情況下比較 onClick 和 onHover 事件資料。檢查 node_modules/plotly.js/src/traces/pie/plot.js 第 471 行附近的程式碼,並追蹤 click callback 接收其點資料的時機。完成標準是:React 重新渲染後重複點擊時,始終包含 percent、bbox 和預期的數字文字。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- javascript, react
- 領域
- data-visualization, frontend
- Issue 類型
- 缺陷
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 活躍度
- 冷清
- 描述清晰度
- 基本清楚
- 新手友好度
- 48/100