[charts] Add typedocs to pubic hooks and improve types

[JCQuintas]

• added docs to all public hooks
• Improve types of useXxxSeries hooks and add more use-cases

[mui-bot]

Deploy preview: https://deploy-preview-15545--material-ui-x.netlify.app/

Generated by 🚫 dangerJS against 7a9241f

[codspeed-hq]

CodSpeed Performance Report

Merging #15545 will not alter performance

_{Comparing JCQuintas:remove-unstable-useseries (7a9241f) with master (ff2947d)}

Summary

✅ 6 untouched benchmarks

[alexfauquette]

I'm wondering if the current hook is the best DX. If we provide something like

useBarSeries(['seriesId1', 'seriesId2']) // Returns the config of the series
useBarSeries() // Returns all bar series in the correct order

It might be easier to use

[JCQuintas]

Do you see a lot of value in returning an array for allowing multiple items to be returned or only allow one return per call?

const a = useSeries('a')
const b = useSeries('b')

vs

const [a,b] useSeries('a', 'b')

[alexfauquette]

The array has the advantage to be easier to understand and to allow adding extra arguments later. But I'm not sure if passing an array like useBarSeries(['seriesId1', 'seriesId2']) could cause perf issue because at each render it would creat a new array 🤔

Maybe we should wait for the end of the plugin migration to see if one DX allows easier perf otpimisation than the other

[JCQuintas]

The array has the advantage to be easier to understand and to allow adding extra arguments later. But I'm not sure if passing an array like useBarSeries(['seriesId1', 'seriesId2']) could cause perf issue because at each render it would creat a new array 🤔

Maybe we should wait for the end of the plugin migration to see if one DX allows easier perf otpimisation than the other

Optimisation-wise we can just ...args into the dep array. Though we have to disable the eslint error for exaustive deps 🙃

[github-actions]

This pull request has conflicts, please resolve those before we can evaluate the pull request.