[BUG]: imperfect type definitions around graph export features
Personne n'a encore pris cette issue.
- Langage dominant
- JavaScript
- Étoiles
- 18.3k
- Forks
- 2k
- Merge moyen
- 2 j 12 h
- PR mergées (30 j)
- 28
Description
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.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Trouvez les définitions *.d.ts de toImage(), downloadImage() et config.toImageButtonOptions, puis comparez-les aux fonctionnalités d’exportation documentées et à CHANGELOG.md. Vérifiez que full-json et imageDataOnly sont représentés et que les propriétés du deuxième paramètre sont facultatives ; les modifications des définitions de types devraient être couvertes par les vérifications existantes du dépôt.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- javascript, typescript
- Domaine
- data-visualization
- Type d'issue
- Bug
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- Active
- Clarté
- Plutôt claire
- Accessibilité débutants
- 72/100