Skip to content

Commit 239a4c5

Browse files
dlabrecqdlabrecq
authored
chore(charts): update documentation for ECharts integration (#11622)
1 parent 546aaa1 commit 239a4c5

File tree

80 files changed

+325
-217
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+325
-217
lines changed

‎packages/react-charts/src/victory/components/Chart/Chart.tsx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -94,14 +94,14 @@ export interface ChartProps extends VictoryChartProps {
9494
/**
9595
* Note: This prop should not be set manually.
9696
*
97-
* @private
97+
* @private Not intended as public API and subject to change
9898
* @hide
9999
*/
100100
defaultAxes?: AxesType;
101101
/**
102102
* Note: This prop should not be set manually.
103103
*
104-
* @private
104+
* @private Not intended as public API and subject to change
105105
* @hide
106106
*/
107107
defaultPolarAxes?: AxesType;
@@ -348,7 +348,7 @@ export interface ChartProps extends VictoryChartProps {
348348
/**
349349
* Note: This prop should not be set manually.
350350
*
351-
* @private
351+
* @private Not intended as public API and subject to change
352352
* @hide
353353
*/
354354
prependDefaultAxes?: boolean;
@@ -391,7 +391,7 @@ export interface ChartProps extends VictoryChartProps {
391391
*
392392
* Note: This prop should not be set manually.
393393
*
394-
* @private
394+
* @private Not intended as public API and subject to change
395395
* @hide
396396
*/
397397
sharedEvents?: { events: any[]; getEventState: Function };

‎packages/react-charts/src/victory/components/ChartArea/ChartArea.tsx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ export interface ChartAreaProps extends VictoryAreaProps {
311311
*
312312
* Note: This prop should not be set manually.
313313
*
314-
* @private
314+
* @private Not intended as public API and subject to change
315315
* @hide
316316
*/
317317
sharedEvents?: { events: any[]; getEventState: Function };

‎packages/react-charts/src/victory/components/ChartArea/examples/ChartArea.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import { getResizeObserver } from '@patternfly/react-core';
1818
## Introduction
1919
Note: PatternFly React charts live in its own package at [@patternfly/react-charts](https://www.npmjs.com/package/@patternfly/react-charts)!
2020

21-
PatternFly React charts are based on the [Victory](https://formidable.com/open-source/victory/docs/victory-chart/) chart library, along with additional functionality, custom components, and theming for PatternFly. This provides a collection of React based components you can use to build PatternFly patterns with consistent markup, styling, and behavior.
21+
The examples below are based on the [Victory](https://formidable.com/open-source/victory/docs/victory-chart/) chart library, along with additional functionality, custom components, and theming for PatternFly. This provides a collection of React based components you can use to build PatternFly patterns with consistent markup, styling, and behavior.
2222

2323
## Examples
2424
### Basic with right aligned legend

‎packages/react-charts/src/victory/components/ChartAxis/ChartAxis.tsx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ export interface ChartAxisProps extends VictoryAxisProps {
305305
*
306306
* Note: This prop should not be set manually.
307307
*
308-
* @private
308+
* @private Not intended as public API and subject to change
309309
* @hide
310310
*/
311311
sharedEvents?: { events: any[]; getEventState: Function };

‎packages/react-charts/src/victory/components/ChartBar/ChartBar.tsx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -306,7 +306,7 @@ export interface ChartBarProps extends VictoryBarProps {
306306
*
307307
* Note: This prop should not be set manually.
308308
*
309-
* @private
309+
* @private Not intended as public API and subject to change
310310
* @hide
311311
*/
312312
polar?: boolean;
@@ -350,7 +350,7 @@ export interface ChartBarProps extends VictoryBarProps {
350350
*
351351
* Note: This prop should not be set manually.
352352
*
353-
* @private
353+
* @private Not intended as public API and subject to change
354354
* @hide
355355
*/
356356
sharedEvents?: { events: any[]; getEventState: Function };

‎packages/react-charts/src/victory/components/ChartBar/examples/ChartBar.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import t_global_color_status_warning_100 from '@patternfly/react-tokens/dist/esm
1515

1616
Note: PatternFly React charts live in its own package at [@patternfly/react-charts](https://www.npmjs.com/package/@patternfly/react-charts)!
1717

18-
PatternFly React charts are based on the [Victory](https://formidable.com/open-source/victory/docs/victory-chart/) chart library, along with additional functionality, custom components, and theming for PatternFly. This provides a collection of React based components you can use to build PatternFly patterns with consistent markup, styling, and behavior.
18+
The examples below are based on the [Victory](https://formidable.com/open-source/victory/docs/victory-chart/) chart library, along with additional functionality, custom components, and theming for PatternFly. This provides a collection of React based components you can use to build PatternFly patterns with consistent markup, styling, and behavior.
1919

2020
## Examples
2121

‎packages/react-charts/src/victory/components/ChartBoxPlot/ChartBoxPlot.tsx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -425,7 +425,7 @@ export interface ChartBoxPlotProps extends VictoryBoxPlotProps {
425425
*
426426
* Note: This prop should not be set manually.
427427
*
428-
* @private
428+
* @private Not intended as public API and subject to change
429429
* @hide
430430
*/
431431
polar?: boolean;
@@ -559,7 +559,7 @@ export interface ChartBoxPlotProps extends VictoryBoxPlotProps {
559559
*
560560
* Note: This prop should not be set manually.
561561
*
562-
* @private
562+
* @private Not intended as public API and subject to change
563563
* @hide
564564
*/
565565
sharedEvents?: { events: any[]; getEventState: Function };

‎packages/react-charts/src/victory/components/ChartBoxPlot/examples/ChartBoxPlot.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import chart_color_orange_300 from '@patternfly/react-tokens/dist/esm/chart_colo
1919
## Introduction
2020
Note: PatternFly React charts live in its own package at [@patternfly/react-charts](https://www.npmjs.com/package/@patternfly/react-charts)!
2121

22-
PatternFly React charts are based on the [Victory](https://formidable.com/open-source/victory/docs/victory-chart/) chart library, along with additional functionality, custom components, and theming for PatternFly. This provides a collection of React based components you can use to build PatternFly patterns with consistent markup, styling, and behavior.
22+
The examples below are based on the [Victory](https://formidable.com/open-source/victory/docs/victory-chart/) chart library, along with additional functionality, custom components, and theming for PatternFly. This provides a collection of React based components you can use to build PatternFly patterns with consistent markup, styling, and behavior.
2323

2424

2525
## Examples

‎packages/react-charts/src/victory/components/ChartBullet/examples/ChartBullet.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import { getResizeObserver } from '@patternfly/react-core';
1616
## Introduction
1717
Note: PatternFly React charts live in its own package at [@patternfly/react-charts](https://www.npmjs.com/package/@patternfly/react-charts)!
1818

19-
PatternFly React charts are based on the [Victory](https://formidable.com/open-source/victory/docs/victory-chart/) chart library, along with additional functionality, custom components, and theming for PatternFly. This provides a collection of React based components you can use to build PatternFly patterns with consistent markup, styling, and behavior.
19+
The examples below are based on the [Victory](https://formidable.com/open-source/victory/docs/victory-chart/) chart library, along with additional functionality, custom components, and theming for PatternFly. This provides a collection of React based components you can use to build PatternFly patterns with consistent markup, styling, and behavior.
2020

2121
## Examples
2222
### Basic

‎packages/react-charts/src/victory/components/ChartBullet/utils/chart-bullet-data.ts‎

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ interface ChartBulletDataInterface {
2222

2323
/**
2424
* Returns comparative measure data
25-
* @private
25+
*
26+
* @private Not intended as public API and subject to change
2627
*/
2728
export const getComparativeMeasureData = ({
2829
data,
@@ -54,7 +55,8 @@ export const getComparativeMeasureData = ({
5455

5556
/**
5657
* Returns comparative error measure data
57-
* @private
58+
*
59+
* @private Not intended as public API and subject to change
5860
*/
5961
export const getComparativeErrorMeasureData = ({
6062
data,
@@ -73,7 +75,8 @@ export const getComparativeErrorMeasureData = ({
7375

7476
/**
7577
* Returns comparative warning data
76-
* @private
78+
*
79+
* @private Not intended as public API and subject to change
7780
*/
7881
export const getComparativeWarningMeasureData = ({
7982
data,
@@ -92,7 +95,8 @@ export const getComparativeWarningMeasureData = ({
9295

9396
/**
9497
* Returns primary dot measure data
95-
* @private
98+
*
99+
* @private Not intended as public API and subject to change
96100
*/
97101
export const getPrimaryDotMeasureData = ({
98102
data,
@@ -115,7 +119,8 @@ export const getPrimaryDotMeasureData = ({
115119

116120
/**
117121
* Returns primary segment measure data
118-
* @private
122+
*
123+
* @private Not intended as public API and subject to change
119124
*/
120125
export const getPrimarySegmentedMeasureData = ({
121126
data,
@@ -182,7 +187,8 @@ export const getPrimarySegmentedMeasureData = ({
182187

183188
/**
184189
* Returns qualitative range data
185-
* @private
190+
*
191+
* @private Not intended as public API and subject to change
186192
*/
187193
export const getQualitativeRangeData = ({
188194
data,

0 commit comments

Comments
 (0)