Aria omit columns #20038

semla · 2024-06-17T13:51:56Z

Brief Information

This pull request is in the type of:

bug fixing
new feature
others

What does this PR do?

Allows omitting columns from the 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.columnsToExclude and they will not appear in the data in aria.label.

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

maxDataCnt should then compare towards the remaining columns

echarts-bot · 2024-06-17T13:52:02Z

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.

Ovilia

I'm a little confused about the purpose of this PR. At first glance, I thought this is to ignore some dimensions (i.g.: data: [[100, 100, 2], [200, 300, 4]] for scatters but display only 2 and 4 in aria-label), but based on current implementation, with columnsToExclude: [0, 1], it seems to filter the first and seconda data instead of the first and second dimension of all data.

I tested with the following code:

chart.setOption({
    aria: {
        enabled: true,
        series: {
            multiple: {
                prefix: '{seriesCount}个图表系列组成了该图表。'
            }
        },
        data: {
            columnsToExclude: [1]
        }
    },
    tooltip : {
        trigger: 'axis',
        axisPointer : {            // 坐标轴指示器，坐标轴触发有效
            type : 'shadow'        // 默认为直线，可选为：'line' | 'shadow'
        }
    },
    legend: {
        data:['热度', '正面', '负面']
    },
    grid: {
        left: '3%',
        right: '4%',
        bottom: '3%',
        containLabel: true
    },
    xAxis : [
        {
            type : 'value'
        }
    ],
    yAxis : [
        {
            type : 'category',
            axisTick : {show: false},
            data : ['汽车之家','今日头条','百度贴吧','一点资讯','微信','微博','知乎']
        }
    ],
    series : [
        {
            name:'热度',
            type:'bar',
            label: {
                normal: {
                    show: true,
                    position: 'inside'
                }
            },
            data:[300, 270, 340, 344, 300, 320, 310]
        },
        {
            name:'正面',
            type:'bar',
            stack: '总量',
            label: {
                normal: {
                    show: true
                }
            },
            data:[120, 102, 141, 174, 190, 250, 220]
        },
        {
            name:'负面',
            type:'bar',
            stack: '总量',
            label: {
                normal: {
                    show: true,
                    position: 'left'
                }
            },
            data:[-20, -32, -21, -34, -90, -130, -110]
        }
    ]
});

Ovilia · 2024-06-19T07:27:01Z

src/visual/aria.ts

+                    let data = seriesModel.getData();
+                    const columnsToExclude = labelModel.get(['data', 'columnsToExclude']);
+                    if (columnsToExclude) {
+                        data = data.filterSelf(idx => !columnsToExclude?.includes(idx));


This will make the elements in the chart not rendered. What we want is only to change the aria-label instead of the original chart.

I wanted to do the filtering before the check with maxDataCnt - but of course using filterSelf was all wrong.
I have switched back to the old solution in commit 77580e9.
Regarding maxDataCnt, I guess the length of the array columnsToExclude could be added to maxDataCnt to compensate for the excluded columns:

if (columnsToExclude) { maxDataCnt += columnsToExclude.length; }

What do you think?

What kind of filtering does this PR want to provide? Do you want to hiding some bars or only eliminate some dimensions from aria-label (in which case you shouldn't call filterSelf because it changes the data itself)?

What kind of filtering does this PR want to provide? Do you want to hiding some bars or only eliminate some dimensions from aria-label (in which case you shouldn't call filterSelf because it changes the data itself)?

Only eliminate some dimensions form aria-label. So filterSelf was a mistake .

and for nested array

Ovilia · 2024-06-21T08:44:34Z

src/visual/aria.ts

                    const dataLabels = [];
                    for (let i = 0; i < data.count(); i++) {
-                        if (i < maxDataCnt) {
+                        if (i < maxDataCnt && !columnsToExclude?.includes(i)) {


i is the index of data. How can we filter certain dimensions by checking index of data? The current code is more like dataIndexToExclude than columnsToExclude.

Thanks, how about bcd1a81 instead?

Ovilia · 2024-06-21T08:45:13Z

Please make this PR "ready for review" when you are ready so that we know it's time for us to review. Thanks!

that omits lat & long for aria-label

Ovilia · 2024-06-28T11:03:14Z

Is this PR ready for review?

semla · 2024-07-17T10:23:52Z

Is this PR ready for review?

I think so

…onents (resolves #20128)

… not show after dispatching `legendAllSelect` action.

…e v5.0.0

…tibility

… instance rather than create an new function to reduce runtime memory cost (fix #20151)

Bumps [socket.io-parser](https://github.com/Automattic/socket.io-parser) from 3.3.3 to 3.3.4. - [Release notes](https://github.com/Automattic/socket.io-parser/releases) - [Changelog](https://github.com/socketio/socket.io-parser/blob/3.3.4/CHANGELOG.md) - [Commits](socketio/socket.io-parser@3.3.3...3.3.4) --- updated-dependencies: - dependency-name: socket.io-parser dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]>

Ovilia

There seems to be a lot of commits included in this PR. Please make sure you merged master correctly.

semla · 2024-07-29T08:11:54Z

There seems to be a lot of commits included in this PR. Please make sure you merged master correctly.

How about I delete this PR and create a new "clean" one?

Ovilia · 2024-08-01T06:47:29Z

Yes, that should be good.

semla · 2024-08-01T10:46:52Z

#20218

semla and others added 4 commits June 14, 2024 11:58

feat(aria): omit columns

ad1d487

add test for excluding data from aria

64b51e9

exclude aria columns directly

5ad8f6e

maxDataCnt should then compare towards the remaining columns

Merge branch 'apache:master' into aria-omit-columns

a67fd83

echarts-bot bot added PR: awaiting doc Document changes is required for this PR. PR: awaiting review PR: first-time contributor labels Jun 17, 2024

pull-request-size bot added the size/XS label Jun 17, 2024

Ovilia requested changes Jun 19, 2024

View reviewed changes

echarts-bot bot added PR: revision needed and removed PR: awaiting review labels Jun 19, 2024

semla marked this pull request as draft June 19, 2024 17:05

Merge branch 'apache:master' into aria-omit-columns

99d9731

echarts-bot bot removed the PR: revision needed label Jun 20, 2024

semla added 2 commits June 20, 2024 11:25

fix(aria): filter columns and only aria

77580e9

test(aria): add test for not modifying graph data

1b630cb

and for nested array

Ovilia requested changes Jun 21, 2024

View reviewed changes

echarts-bot bot added the PR: revision needed label Jun 21, 2024

semla added 2 commits June 21, 2024 20:49

fix(aria): filter columns, not data items

bcd1a81

test(aria): update test to realistic use case

9cb5d9a

that omits lat & long for aria-label

echarts-bot bot removed the PR: revision needed label Jun 21, 2024

semla mentioned this pull request Jun 22, 2024

[Bug] Incorrect data for aria-label #20063

Open

semla and others added 2 commits July 15, 2024 18:44

Merge branch 'apache:master' into aria-omit-columns

94fd435

test(aria): rename test file

da33a83

semla marked this pull request as ready for review July 16, 2024 12:53

echarts-bot bot added the PR: awaiting review label Jul 16, 2024

echarts-bot bot removed the PR: awaiting review label Jul 26, 2024

plainheart and others added 17 commits July 26, 2024 12:55

fix(legend): fix legend action is not isolated from other legend comp…

34b4eed

…onents (resolves #20128)

test(legend): add a test case for legend action

7b5e85b

fix(legend): fix legend item is selected but corresponding series may…

d76ce4e

… not show after dispatching `legendAllSelect` action.

fix(legend): remove unused import

f2c165d

fix(legend): remove duplicated type of legend select method name

5a1ad78

fix(legend): return allSelectedMap rather than selectedMap

1a456fa

fix(candlestick): add back missing support for non-normal states sinc…

c74c28a

…e v5.0.0

fix(candlestick): disable emphasis state by default for forward compa…

5bcac1c

…tibility

fix(candelstick): still enable emphasis state by default

c630017

perf(line): prebind context of _changePolyState function to current…

0ab51ee

… instance rather than create an new function to reduce runtime memory cost (fix #20151)

feature(axis): add feature to remove SplitLine on specified tick

212ee25

fix(pie): Missing pie chart label display. close #20070

01c2e6e

fix(pie): fix some labels may not show #20074

b3eac27

fix(axis): ticks overflowing grid area with dataZoom #20185

1a06ff8

perf(aria): use functions from zrender

50339df

test(aria): also test values that should exist

9a65f9d

echarts-bot bot added PR: awaiting review and removed PR: revision needed labels Jul 26, 2024

pull-request-size bot added size/L and removed size/XS labels Jul 26, 2024

Ovilia requested changes Jul 29, 2024

View reviewed changes

echarts-bot bot added PR: revision needed and removed PR: awaiting review labels Jul 29, 2024

Ovilia closed this Aug 2, 2024

semla deleted the aria-omit-columns branch August 9, 2024 16:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Aria omit columns #20038

Aria omit columns #20038

semla commented Jun 17, 2024

echarts-bot bot commented Jun 17, 2024

Ovilia left a comment

Ovilia Jun 19, 2024

semla Jun 20, 2024

Ovilia Jun 21, 2024

semla Jun 21, 2024

Ovilia Jun 21, 2024

semla Jun 21, 2024

Ovilia commented Jun 21, 2024

Ovilia commented Jun 28, 2024

semla commented Jul 17, 2024

Ovilia left a comment

semla commented Jul 29, 2024

Ovilia commented Aug 1, 2024

semla commented Aug 1, 2024

Aria omit columns #20038

Aria omit columns #20038

Conversation

semla commented Jun 17, 2024

Brief Information

What does this PR do?

Fixed issues

Details

Before: What was the problem?

After: How does it behave after the fixing?

Document Info

Misc

ZRender Changes

Related test cases or examples to use the new APIs

Others

Merging options

Other information

echarts-bot bot commented Jun 17, 2024

Ovilia left a comment

Choose a reason for hiding this comment

Ovilia Jun 19, 2024

Choose a reason for hiding this comment

semla Jun 20, 2024

Choose a reason for hiding this comment

Ovilia Jun 21, 2024

Choose a reason for hiding this comment

semla Jun 21, 2024

Choose a reason for hiding this comment

Ovilia Jun 21, 2024

Choose a reason for hiding this comment

semla Jun 21, 2024

Choose a reason for hiding this comment

Ovilia commented Jun 21, 2024

Ovilia commented Jun 28, 2024

semla commented Jul 17, 2024

Ovilia left a comment

Choose a reason for hiding this comment

semla commented Jul 29, 2024

Ovilia commented Aug 1, 2024

semla commented Aug 1, 2024