plotly / plotly/plotly.js

Bug: Exporting as HTML (New Issues as of v.3.0.1)

Aperta
#7,372 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

bug P2
Lingua principale
JavaScript
Stelle
18.3k
Fork
2k
Merge medio
2g 12h
PR unite (30g)
28

Descrizione

Hey, I have been using plotly.js within my react application for several months now.
I never noticed this issue before but my users have started to report the following issue as of today, and I wonder if its linked to the latest release of plotlyjs.

In my React app I'm using a combination of react plotly and plotlyjs for various bits of functionality.

The key bit thats relevant here, is exporting charts as HTML.

Since the js client has no .to_html method like the python client does, I had to do this with a bit of a workaround as suggested by other people online.

// Function to export as HTML
    const exportAsHTML = (chartData: ChartData, fileName: string) => {
        const plotlyScript = `
        <script src="https://cdn.plot.ly/plotly-latest.min.js"></script>
        <style>
            body, html {
                margin: 0;
                padding: 0;
                width: 100%;
                height: 100%;
                overflow: hidden;
            }
            #plotly-chart {
                width: 100%;
                height: 100%;
            }
        </style>
        <div id="plotly-chart"></div>
        <script>
            var data = ${JSON.stringify(chartData.data)};
            var layout = ${JSON.stringify(chartData.layout)};
            Plotly.newPlot('plotly-chart', data, layout);
        </script>
        `;
        const blob = new Blob([plotlyScript], { type: 'text/html' });
        const url = URL.createObjectURL(blob);
        const link = document.createElement('a');
        link.href = url;
        link.download = fileName;
        document.body.appendChild(link);
        link.click();
        document.body.removeChild(link);
        URL.revokeObjectURL(url);
    };

Basically I'm creating the HTML skeleton myself and passing in the chart data / layout to be read by the embedded plotly client.

Here i'm explicitly importing the latest version of plotlyjs via the <script/> tag

Now as for the results. The html version of the chart is either missing data entirely, or the data has been mutated such that it doesn't match the original chart.

A couple of examples are below.


EXAMPLE A

This chart (plotted using React Plotly)

Image

Becomes the following (missing data entirely)

Image


EXAMPLE B

This chart (plotted using React Plotly)

Image

Becomes the following (shape of data changed drastically)

Image


Obviously this is a major issue and if not fixed could mislead our data analysts.

The only solution i can think of for now is to create a python backend endpoint to take the chart data and layout and use the python libraries to_html function to send back the html, but this seems unnecessarily convoluted.

Now, it could be that I have been taking the wrong approach the whole time, but I'd be surprised if this was the case since the feature has been live for months and has only now been reported as buggy. Hence why I suspect its to do with the latest release (21 hours ago as of writing this)

As a sidenote, why on earth isn't there a built in .to_html method in the javascript client library? The disparity between this and the python library is confusing.

Any guidance is appreciated.

Best,
Pat

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia riproducendo il problema con la funzione exportAsHTML fornita, i dati e il layout del grafico interessati e il client Plotly più recente caricato dal CDN. Confronta il grafico React Plotly originale con l’output HTML scaricato e determina se i dati vengono persi o modificati durante l’esportazione o il rendering. Il lavoro è completato quando l’HTML esportato conserva i dati e la forma del grafico.

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à
4/5
Tempo stimato
3-5 giorni
Stato di attività
Attiva
Chiarezza
Da chiarire
Idoneità per principianti
38/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.