[BUG]: incorrect `downloadImage` type definition

Offen Anfängerfreundlich

#8,072 erstellt am 24.9.2026 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 1/5
Geschätzter Aufwand: Unter einer Stunde
Anfängerfreundlichkeit: 85/100

Issue-Typ: Bug
Klarheit: Klar beschrieben
Aktivitätsstatus: Aktiv
Tech-Stack: javascript, typescript
Bereich: documentation

Rechercherichtung

Das Issue verweist auf die Typdefinition für downloadImage in den TypeScript-Definitionen. Überprüfe die Quelldatei src/snapshot/download.js, um zu sehen, wie opts behandelt wird (es erlaubt nullish-Werte). Aktualisiere dann die TypeScript-Definition, um den Parameter opts optional zu machen, entsprechend dem Verhalten von toImage. Überprüfe die Änderung durch einen einfachen TypeScript-Kompilierungstest.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

bug

Description

I'm happy to see type definitions about image export features were improved in recent PR #8066. Let me point out a minor type problem that (I think) remains after the PR.

The second parameter opts in downloadImage() function is required but I think it should be optional. That in toImage() is optional.

export function downloadImage(root: RootOrData, opts: DownloadImgopts): Promise<string>;

Because of this, a TS compiler complains about Plotly.downloadImage('graphDiv'), while it works as JS code. It seems the source code (src/snapshot/download.js) allows opts to be nullish.

There is a workaround such as calling Plotly.downloadImage('graphDiv', {}), and so this problem is not serious. I would be happy if it were fixed in future.

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

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

Mehr aus plotly/plotly.js

[CHORE]: Warn on config values that do not match the schema Offen

chore P3 plotly-internal size: 3 task

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 77/100

plotly/plotly.js#8064 · Erstellt am 21.9.2026
[CHORE]: Change default to `true` for `responsive` config attribute Offen

chore P1 plotly-internal size: 1 task

Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 82/100

plotly/plotly.js#8034 · Erstellt am 10.9.2026
[CHORE]: Deprecate plotly.js-mapbox* npm packages Offen

chore P3 plotly-internal size: 1 task

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100

plotly/plotly.js#8029 · Erstellt am 08.9.2026
[mkdocs] Update link in Edit this Page button Offen

bug

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100

plotly/plotly.js#7648 · 3 Kommentare · Erstellt am 18.11.2025
BUILDING.md: minor typo and some Markdown syntax errors Offen

bug infrastructure P2

Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 65/100

plotly/plotly.js#6930 · Erstellt am 15.3.2024

Alle Issues in plotly/plotly.js