[BUG]: imperfect type definitions around graph export features

Offen Anfängerfreundlich
#8,057 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
72/100
Issue-Typ
Bug
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv

Rechercherichtung

Suchen Sie die *.d.ts-Definitionen für toImage(), downloadImage() und config.toImageButtonOptions und vergleichen Sie sie mit den dokumentierten Exportfunktionen und CHANGELOG.md. Bestätigen Sie, dass full-json und imageDataOnly dargestellt sind und dass die Eigenschaften des zweiten Parameters optional sind; die Änderungen an den Typdefinitionen sollten durch die bestehenden Prüfungen des Repositorys abgedeckt sein.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

bug
Description

I found the following imperfect definitions in type definitions Plotly introduced recently (v4.0.0?), around toImage(), downloadImage() and config.toImageButtonOptions. This will hinder using these functions/option for TypeScript users (like me).

  • Lack of full-json export format. A graph can be exported as JSON probably since v1.53.0 (see CHANGELOG.md or #4593) but this feature was not documented until very recently (plotly/graphing-library-docs#471).
  • Lack of imageDataOnly option. This option is also very recently documented here.
  • Some properties being set as required. The properties of the second parameter in toImage() and downloadImage() should be all optional. Currently some are required.

Can I send a PR for these? The PR won't include changes on executable code in JS; it will only modify *.d.ts files and maybe docstring parts in JS files.

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus plotly/plotly.js

Alle Issues in plotly/plotly.js

Ähnliche Issues

Weitere Issues zu JavaScript

Neue Issues direkt in Ihr Postfach

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