[BUG]: imperfect type definitions around graph export features
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- JavaScript
- Sterne
- 18.3k
- Forks
- 2k
- Ø Merge
- 2 T. 12 Std.
- Gemergte PRs (30 T.)
- 28
Beschreibung
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-jsonexport 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
imageDataOnlyoption. This option is also very recently documented here. - Some properties being set as required. The properties of the second parameter in
toImage()anddownloadImage()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.
Beitragsleitfaden
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
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.
Bewertung
- Tech-Stack
- javascript, typescript
- Bereich
- data-visualization
- Issue-Typ
- Bug
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Aktiv
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 72/100