plotly / plotly/react-plotly.js
uirevision not preserving the trace's visibility (legend click)
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
When adding the below line to the layout [1], one would expect that the chart preserves the trace's visibility even after the data is reload, or other elements of a webapp change.
Whilst it works nice and clean in a simple test, in an almost empty react project, it doesn't seem to work well in a medium sized app, with dozens of Components and states.
In my specific example, it is enough for someone to change the navigation bar dropdowns, which trigger an event changing the state of App.js, where the charts originate, too. In the very same second when the dropdown changes its value, the charts lose their 'memory' of what was previously selected, and revert back to their original state.
I'll see if I can reproduce this in a sharable code-pen, but perhaps someone already encountered this issue?
Am using react-plotly 2.4.0 with plotly.js 1.48.0
**1**
uirevision: 'true'
Was able to recreate it. ui revision seems to be failing when callbacks are used in reacts setState.
Clicking 'Button2' twice, will reset the selected traces to their default. Simply removing the callback (which does not affect the plot) makes it behave as intended again.
import React, { Component } from 'react';
import './App.css';
import MyPlot from "./plotly_test";
import NavbarTop from "./NavbarTop";
class App extends Component {
constructor() {
super();
this.onClickButton = this.onClickButton.bind(this);
this.onClickButton2 = this.onClickButton2.bind(this);
this.state = {
myID: 1,
countries: {names: ['Alal', 'lqwel', 'qpweok'], labels: ['loqwe', 'qwoel', 'qlweo']},
country: 'Poland',
}
};
onClickButton() {
this.setState({myID: this.state.myID + 1})
this.changeCountry = this.changeCountry.bind(this);
var labels = this.state.countries.labels
this.setState({
labels: labels.push('SomeLabel')
})
}
onClickButton2() {
this.setState({
country: "SomeCountry",
}, ()=>{
this.setState({
country: 'Yet Another'
})
})
}
changeCountry = (value, callback) => {
this.setState({
country: value,
}, () => {
callback(value)
})
};
getCharts() {
let components = [];
components.push((<MyPlot id={this.state.myID}/>));
return components
}
render() {
let charts = this.getCharts();
return (
<div>
<h1>{this.state.country}</h1>
<NavbarTop callbackChange={this.changeCountry}/>
<div className="App">
{charts}
<button
onClick={this.onClickButton}
> Button1
</button>
<button
onClick={this.onClickButton2}
> Button2
</button>
</div>
</div>
)
}
}
export default App;
Navbar:
import React, { Component } from 'react';
class NavbarTop extends Component {
constructor(props) {
super(props);
this.handleChange = this.handleChange.bind(this);
}
handleChange(event) {
this.props.callbackChange(event.target.value, (something) => {
console.log(something);
})
}
render() {
return (
<div>
<nav>
<nav>
<select name="countries" id="countries"
onChange={this.handleChange} value={'PL'}>
<option value='DE'>Germany</option>
<option value='FR'>France</option>
<option value='ES'>Spain</option>
<option value='UK'>United Kingdom</option>
</select>
</nav>
</nav>
</div>
);
}
}
export default NavbarTop;
plotly_test:
import React, {Component} from 'react'
import Plot from 'react-plotly.js'
class MyPlot extends Component {
render() {
const rand = () => 1;
var x = [1, 2, 3, 4, 5];
const new_data = (trace) => Object.assign(trace, {y: x.map(rand)});
// add random data to three line traces
var data = [
{mode:'lines', line: {color: "#b55400"}},
{mode: 'lines', line: {color: "#393e46"}},
{mode: 'lines', line: {color: "#222831"}}
].map(new_data);
var layout = {
title: this.props.id,
uirevision:'true',
xaxis: {autorange: true},
yaxis: {autorange: true}
};
return (
<div>
<Plot
layout={layout}
data={data}
/>
</div>
);
}
}
export default MyPlot;
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginnen Sie mit der bereitgestellten App-Komponente sowie den Komponenten plotly_test und NavbarTop. Reproduzieren Sie anschließend das Problem, indem Sie auf ein Legendenelement klicken und die callback-basierten setState-Aktualisierungen von Button2 auslösen. Verfolgen Sie, wie react-plotly.js die aktualisierten Props erhält, und ermitteln Sie, warum uirevision die Sichtbarkeit nicht mehr bewahrt; als erledigt gilt die Aufgabe, wenn die Sichtbarkeit des ausgewählten Traces nach diesen Aktualisierungen unverändert bleibt.
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
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100