You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@echarts.apache.org by "sjcobb (via GitHub)" <gi...@apache.org> on 2023/05/10 13:51:38 UTC
[GitHub] [echarts] sjcobb opened a new pull request, #18607: export CallbackDataParams from util/types
sjcobb opened a new pull request, #18607:
URL: https://github.com/apache/echarts/pull/18607
## Brief Information
This pull request is in the type of:
- [ ] bug fixing
- [ ] new feature
- [x] others
### What does this PR do?
Export out CallbackDataParams from src/util/types as part of public API for use by consumers.
### Fixed issues
None for this specific type, but I can create one (there are other types I'd love to be exported as well if a single issue with all the requests is preferred)
<!--
- #xxxx: ...
-->
## Details
### Before: What was the problem?
We have a ECharts react wrapper component in this project https://github.com/perses/perses where we are re-defining this type, see [interface defined here](https://github.com/perses/perses/blob/v0.29.1/ui/components/src/EChart/EChart.tsx#L21-L34).
echarts-for-react has a [similar issue](https://github.com/hustcc/echarts-for-react/blob/e33247b9b8f55e53e8fa3a02bf92643877366559/src/types.ts#L65), but they opted to not define the callback types explicitly, which will not work for our project since we have stricter eslint settings.
<!-- DESCRIBE THE BUG OR REQUIREMENT HERE. -->
<!-- ADD SCREENSHOT HERE IF APPLICABLE. -->
### After: How does it behave after the fixing?
Type is exported as part of public API.
## Document Info
One of the following should be checked.
- [ ] This PR doesn't relate to document changes
- [ ] The document should be updated later
- [ ] The document changes have been made in apache/echarts-doc#xxx
## Misc
### ZRender Changes
- [ ] This PR depends on ZRender changes (ecomfe/zrender#xxx).
### Related test cases or examples to use the new APIs
N.A.
## Others
### Merging options
- [ ] Please squash the commits into a single one when merging.
### Other information
Exporting some of the other types we've redefined would also be really helpful 🙏 , what is the general rule for what can be exported as part of the public API?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For additional commands, e-mail: commits-help@echarts.apache.org
[GitHub] [echarts] sjcobb commented on pull request #18607: export CallbackDataParams from util/types
Posted by "sjcobb (via GitHub)" <gi...@apache.org>.
sjcobb commented on PR #18607:
URL: https://github.com/apache/echarts/pull/18607#issuecomment-1575296405
Closing PR since export is unnecessary (see [comment](https://github.com/apache/echarts/pull/18607#issuecomment-1574571359))
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For additional commands, e-mail: commits-help@echarts.apache.org
[GitHub] [echarts] sjcobb commented on pull request #18607: export CallbackDataParams from util/types
Posted by "sjcobb (via GitHub)" <gi...@apache.org>.
sjcobb commented on PR #18607:
URL: https://github.com/apache/echarts/pull/18607#issuecomment-1574571359
> https://github.com/apache/echarts/pull/18607/files#diff-68e24c987607b526e911e41eeefd62c918bfad7ec6d3af6e998c7b8c54e95f2eR40
>
> It could be imported here.
Thanks! I also completely missed that this is already exported out with the name `DefaultLabelFormatterCallbackParams` [here](https://github.com/apache/echarts/blob/5.4.2/src/export/option.ts#L286). 😣 Sorry for the noise with this PR, but I appreciate the review.
I noticed a [TODO](https://github.com/apache/echarts/blob/5.4.2/src/util/types.ts#L675
) above where CallbackDataParams is defined, `TODO: TYPE Different callback param for different series` that I could potentially look into in a separate PR if there is interest?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For additional commands, e-mail: commits-help@echarts.apache.org
[GitHub] [echarts] echarts-bot[bot] commented on pull request #18607: export CallbackDataParams from util/types
Posted by "echarts-bot[bot] (via GitHub)" <gi...@apache.org>.
echarts-bot[bot] commented on PR #18607:
URL: https://github.com/apache/echarts/pull/18607#issuecomment-1542255645
Thanks for your contribution!
The community will review it ASAP. In the meanwhile, please checkout [the coding standard](https://echarts.apache.org/en/coding-standard.html) and Wiki about [How to make a pull request](https://github.com/apache/echarts/wiki/How-to-make-a-pull-request).
⚠️ MISSING DOCUMENT INFO: Please make sure one of the document options are checked in this PR's description. Search "Document Info" in the description of this PR. This should be done either by the author or the reviewers of the PR.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For additional commands, e-mail: commits-help@echarts.apache.org
[GitHub] [echarts] sjcobb closed pull request #18607: export CallbackDataParams from util/types
Posted by "sjcobb (via GitHub)" <gi...@apache.org>.
sjcobb closed pull request #18607: export CallbackDataParams from util/types
URL: https://github.com/apache/echarts/pull/18607
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For additional commands, e-mail: commits-help@echarts.apache.org