From 44024cdd3d5304ac50973beedda5bdacf0eeb17d Mon Sep 17 00:00:00 2001 From: alexandre Date: Mon, 3 Jun 2024 09:43:41 +0200 Subject: [PATCH] [docs] Fix the description of --- docs/translations/api-docs/charts/axis-config.json | 2 +- .../api-docs/charts/charts-x-axis/charts-x-axis.json | 2 +- .../api-docs/charts/charts-y-axis/charts-y-axis.json | 2 +- packages/x-charts/src/ChartsXAxis/ChartsXAxis.tsx | 6 ++++-- packages/x-charts/src/ChartsYAxis/ChartsYAxis.tsx | 6 ++++-- packages/x-charts/src/hooks/useTicks.ts | 6 ++++-- 6 files changed, 15 insertions(+), 9 deletions(-) diff --git a/docs/translations/api-docs/charts/axis-config.json b/docs/translations/api-docs/charts/axis-config.json index a0bc3d838875..d43d6be5dd39 100644 --- a/docs/translations/api-docs/charts/axis-config.json +++ b/docs/translations/api-docs/charts/axis-config.json @@ -34,7 +34,7 @@ "stroke": { "description": "The stroke color of the axis line." }, "tickFontSize": { "description": "The font size of the axis ticks text." }, "tickInterval": { - "description": "Defines which ticks are displayed. Its value can be:
- 'auto' In such case the ticks are computed based on axis scale and other parameters.
- a filtering function of the form (value, index) => boolean which is available only if the axis has a data property.
- an array containing the values where ticks should be displayed." + "description": "Defines which ticks are displayed.
Its value can be:
- 'auto' In such case the ticks are computed based on axis scale and other parameters.
- a filtering function of the form (value, index) => boolean which is available only if the axis has "point" scale.
- an array containing the values where ticks should be displayed." }, "tickLabelInterval": { "description": "Defines which ticks get its label displayed. Its value can be:
- 'auto' In such case, labels are displayed if they do not overlap with the previous one.
- a filtering function of the form (value, index) => boolean. Warning: the index is tick index, not data ones." diff --git a/docs/translations/api-docs/charts/charts-x-axis/charts-x-axis.json b/docs/translations/api-docs/charts/charts-x-axis/charts-x-axis.json index 6a3063c582e6..cebaff3cbde6 100644 --- a/docs/translations/api-docs/charts/charts-x-axis/charts-x-axis.json +++ b/docs/translations/api-docs/charts/charts-x-axis/charts-x-axis.json @@ -17,7 +17,7 @@ "stroke": { "description": "The stroke color of the axis line." }, "tickFontSize": { "description": "The font size of the axis ticks text." }, "tickInterval": { - "description": "Defines which ticks are displayed. Its value can be: - 'auto' In such case the ticks are computed based on axis scale and other parameters. - a filtering function of the form (value, index) => boolean which is available only if the axis has a data property. - an array containing the values where ticks should be displayed." + "description": "Defines which ticks are displayed. Its value can be: - 'auto' In such case the ticks are computed based on axis scale and other parameters. - a filtering function of the form (value, index) => boolean which is available only if the axis has "point" scale. - an array containing the values where ticks should be displayed." }, "tickLabelInterval": { "description": "Defines which ticks get its label displayed. Its value can be: - 'auto' In such case, labels are displayed if they do not overlap with the previous one. - a filtering function of the form (value, index) => boolean. Warning: the index is tick index, not data ones." diff --git a/docs/translations/api-docs/charts/charts-y-axis/charts-y-axis.json b/docs/translations/api-docs/charts/charts-y-axis/charts-y-axis.json index 6a3063c582e6..cebaff3cbde6 100644 --- a/docs/translations/api-docs/charts/charts-y-axis/charts-y-axis.json +++ b/docs/translations/api-docs/charts/charts-y-axis/charts-y-axis.json @@ -17,7 +17,7 @@ "stroke": { "description": "The stroke color of the axis line." }, "tickFontSize": { "description": "The font size of the axis ticks text." }, "tickInterval": { - "description": "Defines which ticks are displayed. Its value can be: - 'auto' In such case the ticks are computed based on axis scale and other parameters. - a filtering function of the form (value, index) => boolean which is available only if the axis has a data property. - an array containing the values where ticks should be displayed." + "description": "Defines which ticks are displayed. Its value can be: - 'auto' In such case the ticks are computed based on axis scale and other parameters. - a filtering function of the form (value, index) => boolean which is available only if the axis has "point" scale. - an array containing the values where ticks should be displayed." }, "tickLabelInterval": { "description": "Defines which ticks get its label displayed. Its value can be: - 'auto' In such case, labels are displayed if they do not overlap with the previous one. - a filtering function of the form (value, index) => boolean. Warning: the index is tick index, not data ones." diff --git a/packages/x-charts/src/ChartsXAxis/ChartsXAxis.tsx b/packages/x-charts/src/ChartsXAxis/ChartsXAxis.tsx index 402a561ed031..69c9bf7a3d22 100644 --- a/packages/x-charts/src/ChartsXAxis/ChartsXAxis.tsx +++ b/packages/x-charts/src/ChartsXAxis/ChartsXAxis.tsx @@ -315,10 +315,12 @@ ChartsXAxis.propTypes = { */ tickFontSize: PropTypes.number, /** - * Defines which ticks are displayed. Its value can be: + * Defines which ticks are displayed. + * Its value can be: * - 'auto' In such case the ticks are computed based on axis scale and other parameters. - * - a filtering function of the form `(value, index) => boolean` which is available only if the axis has a data property. + * - a filtering function of the form `(value, index) => boolean` which is available only if the axis has "point" scale. * - an array containing the values where ticks should be displayed. + * @see See {@link https://mui.com/x/react-charts/axis/#fixed-tick-positions} * @default 'auto' */ tickInterval: PropTypes.oneOfType([PropTypes.oneOf(['auto']), PropTypes.array, PropTypes.func]), diff --git a/packages/x-charts/src/ChartsYAxis/ChartsYAxis.tsx b/packages/x-charts/src/ChartsYAxis/ChartsYAxis.tsx index 77c64f662e7d..2992c1714a47 100644 --- a/packages/x-charts/src/ChartsYAxis/ChartsYAxis.tsx +++ b/packages/x-charts/src/ChartsYAxis/ChartsYAxis.tsx @@ -255,10 +255,12 @@ ChartsYAxis.propTypes = { */ tickFontSize: PropTypes.number, /** - * Defines which ticks are displayed. Its value can be: + * Defines which ticks are displayed. + * Its value can be: * - 'auto' In such case the ticks are computed based on axis scale and other parameters. - * - a filtering function of the form `(value, index) => boolean` which is available only if the axis has a data property. + * - a filtering function of the form `(value, index) => boolean` which is available only if the axis has "point" scale. * - an array containing the values where ticks should be displayed. + * @see See {@link https://mui.com/x/react-charts/axis/#fixed-tick-positions} * @default 'auto' */ tickInterval: PropTypes.oneOfType([PropTypes.oneOf(['auto']), PropTypes.array, PropTypes.func]), diff --git a/packages/x-charts/src/hooks/useTicks.ts b/packages/x-charts/src/hooks/useTicks.ts index 2e861a33c88e..8049ebe780d1 100644 --- a/packages/x-charts/src/hooks/useTicks.ts +++ b/packages/x-charts/src/hooks/useTicks.ts @@ -21,10 +21,12 @@ export interface TickParams { */ tickNumber?: number; /** - * Defines which ticks are displayed. Its value can be: + * Defines which ticks are displayed. + * Its value can be: * - 'auto' In such case the ticks are computed based on axis scale and other parameters. - * - a filtering function of the form `(value, index) => boolean` which is available only if the axis has a data property. + * - a filtering function of the form `(value, index) => boolean` which is available only if the axis has "point" scale. * - an array containing the values where ticks should be displayed. + * @see See {@link https://mui.com/x/react-charts/axis/#fixed-tick-positions} * @default 'auto' */ tickInterval?: 'auto' | ((value: any, index: number) => boolean) | any[];