Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 2c57f4b

Browse files
committed
DOC: add whats new for aria roles + svg usage
1 parent 3d570ba commit 2c57f4b

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

doc/users/next_whats_new/aria.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
All ``Arist`` now carry wai-aria data
2+
-------------------------------------
3+
4+
It is now possible to attach `wai-aria
5+
<https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles>`__ role
6+
information to any `~matplotlib.artist.Aritist`. These roles are industry the
7+
industry standard for providing accessibility mark up on the web. This
8+
information can be used by downstream applications for providing accessible
9+
descriptions of visualizations. Best practices in the space are still
10+
developing, but by providing a mechanism to store and access this information
11+
we will enable this development.
12+
13+
There are three methods provided:
14+
15+
- `~matplotlib.artist.Aritist.set_aria` which will completely replace any existing roles.
16+
- `~matplotlib.artist.Aritist.update_aria` which will update the current roles in-place.
17+
- `~matplotlib.artist.Aritist.get_aria` which will return a copy of the current roles.
18+
19+
We currently do no validation on either the keys or the values.
20+
21+
22+
Matplotlib will use the `'aria-label'` role when saving svg output if it is
23+
provided.

0 commit comments

Comments
 (0)