[docs] Document interfaces for charts #12656
Conversation
|
Deploy preview: https://deploy-preview-12656--material-ui-x.netlify.app/ |
github-actions
bot
added
the
PR: out-of-date
|
This pull request has conflicts, please resolve those before we can evaluate the pull request. |
github-actions
bot
removed
the
PR: out-of-date
| { | ||
| pathname: '/x/api/charts-group', |
There was a problem hiding this comment.
I move the "API group" after the "Common features" because it was hard to find
| { | ||
| folder: 'charts', | ||
| packages: ['x-charts'], | ||
| documentedInterfaces: [ | ||
| 'BarSeriesType', | ||
| 'LineSeriesType', | ||
| 'PieSeriesType', | ||
| 'ScatterSeriesType', | ||
| 'AxisConfig', | ||
| ], | ||
| }, | ||
| ]; |
There was a problem hiding this comment.
This is the main modification
| 'bottomAxis', | ||
| 'topAxis', | ||
| 'leftAxis', | ||
| 'rightAxis', | ||
| ]; |
There was a problem hiding this comment.
I removed them from the resolved types because they were too complex to be readable
I plan to add here links to ChartsXAxis props API, but it is blocked by mui/material-ui#41950
| @@ -63,6 +63,11 @@ export interface PieSeriesType<Tdata = PieValueType> extends CommonSeriesType<Td | |||
| * @default 0 | |||
| */ | |||
| paddingAngle?: number; | |||
| /** | |||
| * The sorting strategy used to oredr pie slices. | |||
There was a problem hiding this comment.
small typo
| * The sorting strategy used to oredr pie slices. | |
| * The sorting strategy used to order pie slices. |
No, I recently discovered new ones. The best is to identify which script generate the files, and track back where it is executed(basically how I found the need for mui/material-ui#41950 ) For API page generation it's a bit cleaner because all our configuration is done here: https://github.com/mui/mui-x/tree/master/scripts/buildApiDocs and you can rely on TS |
github-actions
bot
added
the
PR: out-of-date
|
This pull request has conflicts, please resolve those before we can evaluate the pull request. |
github-actions
bot
removed
the
PR: out-of-date
zannager
added
docs
PR on top of #12653
Fix #12380
Added pages
Using
[[BarSeriesType]]in description will generate a link to the API pageSee for example the definition of
seriesprops: https://deploy-preview-12656--material-ui-x.netlify.app/x/api/charts/bar-chart/#bar-chart-prop-series