plotly / plotly/plotly.js

diffConfig always returns true if modeBarButtons (array of array) is populated

Offen
#5,273 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

bug P3
Vorherrschende Sprache
JavaScript
Sterne
18.3k
Forks
2k
Ø Merge
2 T. 12 Std.
Gemergte PRs (30 T.)
28

Beschreibung

diffConfig function has bug where it always returns true if modeBarButtons (array of array) is populated. This results in unnecessary re-rendering. The function should check if the array member is array inside a for loop, It should be -

/*

  • simple diff for config - for now, just treat all changes as equivalent
    */
    function diffConfig(oldConfig, newConfig) {
    var key;

    for(key in oldConfig) {
    if(key.charAt(0) === '_') continue;
    var oldVal = oldConfig[key];
    var newVal = newConfig[key];
    if(oldVal !== newVal) {
    if(Lib.isPlainObject(oldVal) && Lib.isPlainObject(newVal)) {
    if(diffConfig(oldVal, newVal)) {
    return true;
    }
    } else if(Array.isArray(oldVal) && Array.isArray(newVal)) {
    if(oldVal.length !== newVal.length) {
    return true;
    }

             for(var i = 0; i < oldVal.length; i++) {
                 if(oldVal[i] !== newVal[i]) {
     				**if(Array.isArray(oldVal[i]) && Array.isArray(newVal[i])){
     					if(diffConfig(oldVal[i], newVal[i])) {
     						return true;
     					}
     				}							
                     else** if(Lib.isPlainObject(oldVal[i]) && Lib.isPlainObject(newVal[i])) {
                         if(diffConfig(oldVal[i], newVal[i])) {
                             return true;
                         }
                     } else {
                         return true;
                     }
                 }
             }
         } else {
             return true;
         }
     }
    

    }
    }

e.g Config object used -

const plotlyConfig: Partial = {
responsive: true,
displaylogo: false,
displayModeBar: true,
doubleClick: false,
showTips: false,
scrollZoom: false,
modeBarButtons: [
[
'select2d',
'lasso2d',
'zoom2d',
'pan2d',
'resetScale2d',
],
],
locale: language,
locales: locales
}

Beitragsleitfaden

Beitragsleitfaden öffnen

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

Finde die Funktion diffConfig und verwende das plotlyConfig-Beispiel mit verschachtelten modeBarButtons-Arrays als Reproduktionsfall. Vergleiche äquivalente verschachtelte Arrays und stelle sicher, dass unveränderte Konfigurationen nicht als unterschiedlich gemeldet werden, um das unnötige erneute Rendern zu vermeiden; das Issue nennt keine Datei und keinen Test.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
data-visualization, frontend
Issue-Typ
Bug
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
55/100

Neue Issues direkt in Ihr Postfach

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