plotly / plotly/react-plotly.js
onSelected uses stale function even when prop for onSelected changed
Nessuno ha ancora preso questa issue.
- Lingua principale
- JavaScript
- Stelle
- 1.1k
- Fork
- 138
- Merge medio
- 3g 2h
- PR unite (30g)
- 4
Descrizione
While using react plotly I noticed that changes to the onSelected prop are ignored and the initial function used for that prop is called instead when building a lasso based chart. This is an issue when we want to listen to context changes to things like translations.
The code below shows the issue:
const translations = useTranslation<TaggingIndicatorsTranslations>(
allTranslations
);
const [currentBranch] = useBranch();
.....
.....
.....
const filterSelectedProductsWithContext = function filterSelectedProductsCB(
param: PlotSelectionEvent
) {
filterSelectedProducts(param, currentBranch, translations);
};
return (
<div style={{ height: "100%", width: "100%" }}>
<Plot
data={table}
config={{ displayModeBar: false, plotlyServerURL: currentBranch }}
layout={{
dragmode: "lasso",
xaxis: { title: xAndY.x },
yaxis: { title: xAndY.y },
autosize: true,
// title: "Helpful Indicators To Tag",
}}
useResizeHandler
style={{ width: "100%", height: "90%" }}
onSelected={filterSelectedProductsWithContext}
/>
</div>
);
In the above translations and branch are context values (custom context values) that change. We want the behavior of onSelected to change to reflect this (to use a new callback.) Even when changes to data are reflected in the render we still see the stale onSelected is being used when lasso selecting bullet points.
This code snippet was used in a react hook with react-plotly version 2.4.0 and 2.3.0.
I have tried using big arrow and the "function" keyword but neither work. Looking at the source code for factory.js (https://github.com/plotly/react-plotly.js/blob/master/src/factory.js) I do see there is some handler replacement logic in "syncEventHandlers" when handlers are not the same to the props. I was thinking though that the updatePlotly function (that calls this synchronization might) might not be getting called during componentDidUpdate because the onSelected prop wasn't checked.
As a workaround right now I have to take my contexts and place them in a global wrapper so their changes are visible. Its not a good solution but I can't think of a better one and our contexts are mostly global for the entire dom tree anyways.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia in src/factory.js, leggendo syncEventHandlers e il percorso updatePlotly durante componentDidUpdate. Riproduci il caso di selezione con il laccio con valori di contesto variabili e verifica che onSelected utilizzi il callback della prop più recente invece di quello iniziale.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript, react
- Ambito
- data-visualization, frontend
- Tipo di issue
- Bug
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 30/100