[BUG]: imperfect type definitions around graph export features
未关闭
适合新手
还没有人认领这个 Issue。
bug
- 主要语言
- JavaScript
- 星标
- 18.3k
- 派生
- 2k
- 平均合并
- 2 天 12 小时
- 30 天内合并 PR
- 28
描述
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.
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
查找 toImage()、downloadImage() 和 config.toImageButtonOptions 的 *.d.ts 定义,然后将其与文档中记录的导出功能和 CHANGELOG.md 进行比较。确认其中表示了 full-json 和 imageDataOnly,并且第二个参数的属性是可选的;类型定义的更改应由仓库现有的检查覆盖。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- javascript, typescript
- 领域
- data-visualization
- Issue 类型
- 缺陷
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 活跃度
- 活跃
- 描述清晰度
- 基本清楚
- 新手友好度
- 72/100