enh/3957-legend-item-click-event

[hubertkozik]

Introduced new event and option legend.events.itemClick, deprecated events.legendItemClick, closes #3957.

---

I am not sure if we should treat it as a Feature Request (label), but we don't have an Ehnacement label.

---

• To see the specific tasks where the Asana app for GitHub is being used, see below:
  • https://app.asana.com/0/0/1206195038744699

[highsoft-bot]

Visual test results - No difference found

---

Samples changed

Change type	Sample
Added	samples/highcharts/legend/pie-legend-itemclick/demo.js
Added	samples/highcharts/legend/series-legend-itemclick/demo.js
Deleted	samples/highcharts/plotoptions/pie-point-events-legenditemclick/demo.js
Deleted	samples/highcharts/plotoptions/series-events-legenditemclick/demo.js

[highsoft-bot]

File size comparison

Sizes for compiled+gzipped (bold) and compiled files.

	master	candidate	difference
highcharts.js	95.8 kB 270.2 kB	95.7 kB 270.4 kB	-56 B 221 B
highstock.js	128.6 kB 371.9 kB	128.6 kB 372.1 kB	-52 B 221 B
highmaps.js	121.6 kB 349.5 kB	121.6 kB 349.7 kB	-58 B 198 B
highcharts-gantt.js	133.8 kB 385.8 kB	133.7 kB 386.0 kB	-47 B 221 B
dashboards/dashboards.js	43.1 kB 148.4 kB	43.1 kB 148.4 kB	4 B 10 B
datagrid/datagrid.js	24.7 kB 76.8 kB	24.7 kB 76.8 kB	4 B 10 B

[bre1470]

Great work! Looks good. 👍

[KacperMadej]

Could you add the version number after the added deprecated tags? Using @next should work fine.

[bre1470]

Could you add the version number after the added deprecated tags? Using @next should work fine.

Good idea, but this will not work here as these are not API options. JSDoc and Docstrap do not understand extended @deprecate tags. Kacper has to implement it first. 😄

[hubertkozik]

We're using deprecated with version number, e.g. here: https://api.highcharts.com/highcharts/lang.accessibility.resetZoomButton I think it's worth adding it like Kacper suggested.

[bre1470]

This is not supported by JSDoc. Kacper is working on the new class reference, where it can be supported. Only the API options support the extended @deprecated tag.

[TorsteinHonsi]

Thanks, great work!

[TorsteinHonsi]

Suggested change

	if ((item as any).setVisible) {
	(item as any).setVisible();
	}
	(item as Point|Series).setVisible?.();

Trying to get rid of any. I'm not 100% sure this change is correct, can you check that?

[hubertkozik]

It can also be an item as a DataClass legend item, but we don't have good typing for this. Also, the item can be BubbleLegendItem, but this item does not contain setVisible method. Removing this any would need a lot of refactoring, so I left as any here. Do you think this refactor should be done now or we can leave it for this moment?