[Bug] legendToggleSelect action does not support legendIndex, legendName or legendId

[helgasoft]

Version

5.6.0

Link to Minimal Reproduction

Example

Steps to Reproduce

see Example

Current Behavior

legendToggleSelect API says that legendIndex, legendName or legendId parameters are supported since v.5.6.0
Dispatching action legendToggleSelect with any of the above parameters does not change the chart.

Expected Behavior

expecting at least legendIndex and legendName to work.

Environment

- OS: Win 10
- Browser: Chrome
- Framework: none

Any additional comments?

Legend IDs should be defined by data item, but currently one ID is defined for the entire legend ?!
And it does not work on dispatch.

[plainheart]

Like ***Id/***Name/***Index in other components, legendId/legendName/legendIndex is used to explicitly specify the target legend component when there are multiple legend components. legendId/legendName/legendIndex is not equal to seriesId/seriesName/seriesIndex or legendItemName/legendItemIndex.

The right usage should be like this:

myChart.dispatchAction({
  type: 'legendToggleSelect',
  name: 'Legend A', // <-- this is the name of a legend item or a series

  legendName: 'legendComponentNameA', // <--  this is the name of a whole legend component ( NOT EQUAL TO the above 'name')
  legendIndex: 'legendComponentIndexA', // <--  this is the index of a whole legend component,
  legendId: 'legendComponentIdA', // <--  this is the id of a whole legend component,
});

You can also see #20129 for the context.

I also updated the documentation to add some tips.

[helgasoft]

@plainheart, thank you for clarifying. Certain details are still obscure though.
legend has 6 types of action. Which ones are defined for series name and which ones for legend components with legendIndex (id, name) ?
I did a Test and the results are:
  legendAllSelect and legendInverseSelect work for legend components
  legendSelect, legendUnSelect, legendToggleSelect do not seem to work for legend components
  legendScroll not tested
Maybe adding some code examples like this one will help.
Oops, there is a code example which confirms my findings, but they need to be reflected in the documentation.

BTW, legendName assumes a legend name, but name is missing in legend API

[plainheart]

legendSelect, legendUnSelect, legendToggleSelect do not seem to work for legend components

I just noticed these actions are commonly for a single item but not the whole legend component, and the same legend item name will be shared among multiple series, it doesn't make sense to use legendName/legendId/legendIndex when dispatching such actions. Maybe they should be removed from the legend action document.

legendAllSelect and legendInverseSelect work for legend components

Yes. This is why I opened #20129.

BTW, legendName assumes a legend name, but name is missing in legend API

You are right. It has been missing from the documentation for a long time. But legendId and legendIndex should be enough for most scenarios. I will consider removing it from the documentation to avoid potential confusion.