[BUG]: imperfect type definitions around graph export features

Abierto Apto para principiantes
#8,057 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
72/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
javascript, typescript
Área
data-visualization

Línea de trabajo

Localiza las definiciones *.d.ts de toImage(), downloadImage() y config.toImageButtonOptions, y compáralas con las funciones de exportación documentadas y CHANGELOG.md. Confirma que full-json e imageDataOnly están representados y que las propiedades del segundo parámetro son opcionales; los cambios en las definiciones de tipos deberían estar cubiertos por las comprobaciones existentes del repositorio.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
JavaScript
Estrellas
18.3k
Forks
2k
Merge medio
2 d 12 h
PR fusionados (30 d)
28

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de plotly/plotly.js

Todos los issues de plotly/plotly.js

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.