Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(aria): allows excluding data in aria-label #20218

Merged
merged 2 commits into from
Aug 5, 2024

Conversation

semla
Copy link
Contributor

@semla semla commented Aug 1, 2024

Brief Information

This pull request is in the type of:

  • bug fixing
  • new feature
  • others

What does this PR do?

Allows excluding data in aria-label

Fixed issues

Details

Before: What was the problem?

All data was present in the aria-label. My use case was for a map chart, where the coordinates should be excluded.

After: How does it behave after the fixing?

Add column indexes to be excluded to aria.data.excludeDataId and they will not appear in the data in aria.label.

Document Info

One of the following should be checked.

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

@echarts-bot echarts-bot bot added PR: awaiting doc Document changes is required for this PR. PR: awaiting review labels Aug 1, 2024
Copy link

echarts-bot bot commented Aug 1, 2024

Thanks for your contribution!
The community will review it ASAP. In the meanwhile, please checkout the coding standard and Wiki about How to make a pull request.

Document changes are required in this PR. Please also make a PR to apache/echarts-doc for document changes and update the issue id in the PR description. When the doc PR is merged, the maintainers will remove the PR: awaiting doc label.

@semla semla mentioned this pull request Aug 1, 2024
8 tasks
@@ -1733,7 +1733,8 @@ export interface AriaLabelOption {
separator?: {
middle?: string;
end?: string;
}
},
excludeDataId?: number[]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please rename excludeDataId into excludeDimensionId. Thanks!

Copy link
Contributor

github-actions bot commented Aug 2, 2024

The changes brought by this PR can be previewed at: https://echarts.apache.org/examples/editor?version=PR-20218@b1a2374

semla added a commit to semla/echarts-doc that referenced this pull request Aug 3, 2024
@echarts-bot echarts-bot bot added PR: doc ready and removed PR: awaiting doc Document changes is required for this PR. labels Aug 3, 2024
@Ovilia Ovilia added this to the 5.5.2 milestone Aug 5, 2024
@Ovilia Ovilia merged commit 4379789 into apache:master Aug 5, 2024
2 checks passed
Copy link

echarts-bot bot commented Aug 5, 2024

Congratulations! Your PR has been merged. Thanks for your contribution! 👍

@Ovilia Ovilia added PR: awaiting doc Document changes is required for this PR. and removed PR: doc ready labels Aug 5, 2024
@Ovilia
Copy link
Contributor

Ovilia commented Aug 5, 2024

Thanks for your contribution! Please also make a pull request to echarts-doc, adding the new option in the document. You should commit the changes in the zh and en directory only. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: awaiting doc Document changes is required for this PR. size/XS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants