[BUG]: imperfect type definitions around graph export features
Nessuno ha ancora preso questa issue.
- Lingua principale
- JavaScript
- Stelle
- 18.3k
- Fork
- 2k
- Merge medio
- 2g 12h
- PR unite (30g)
- 28
Descrizione
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.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Individua le definizioni *.d.ts di toImage(), downloadImage() e config.toImageButtonOptions, quindi confrontale con le funzionalità di esportazione documentate e con CHANGELOG.md. Verifica che full-json e imageDataOnly siano rappresentati e che le proprietà del secondo parametro siano opzionali; le modifiche alle definizioni dei tipi dovrebbero essere coperte dai controlli esistenti del repository.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript, typescript
- Ambito
- data-visualization
- Tipo di issue
- Bug
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Attiva
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 72/100