Repository navigation
fix(types): add axis properties to CallbackDataParams. close #17561 - #21836
Open
Prakhar1Ojha wants to merge 1 commit into
Open
Prakhar1Ojha wants to merge 1 commit into
Prakhar1Ojha wants to merge 1 commit into
Conversation
|
Thanks for your contribution! Please DO NOT commit the files in dist, i18n, and ssr/client/dist folders in a non-release pull request. These folders are for release use only. |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Brief Information
This pull request is in the type of:
What does this PR do?
Add axis context properties (
axisDim,axisIndex,axisType,axisId,axisValue,axisValueLabel) to the publicCallbackDataParamstype definition.Fixed issues
Details
Before: What was the problem?
At runtime, whenever tooltips or formatters are invoked in an axis context (e.g.,
trigger: 'axis'), ECharts populates axis context properties onto callback parameters (axisDim,axisIndex,axisType,axisId,axisValue, andaxisValueLabelinsrc/component/tooltip/TooltipView.ts:587-595).However, the public TypeScript interface
CallbackDataParamsinsrc/util/types.tsomitted these optional properties. As a consequence, TypeScript users writing custom formatter functions (such asformatter: (params: CallbackDataParams) => ...) experienced compile-time errors:Property 'axisValueLabel' does not exist on type 'CallbackDataParams'.After: How does it behave after the fixing?
axisDim,axisIndex,axisType,axisId,axisValue, andaxisValueLabelproperties onCallbackDataParamsinsrc/util/types.ts.TooltipCallbackDataParamsinsrc/component/tooltip/TooltipView.tsto directly aliasCallbackDataParams.test/ut/spec/util/types.test.tsverifying thataxisValueandaxisValueLabelcan be accessed onCallbackDataParamswithout compiler or runtime diagnostics.Document Info
Misc
Security Checking
ZRender Changes
Related test cases or examples to use the new APIs
test/ut/spec/util/types.test.tsMerging options
Other information
npm run checktype: passed (0 errors)npm run checkheader: passed (0 errors)npm run lint: passed (0 errors, 0 warnings)