@fluentui/react-charts 9.0.2 → 9.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (229) hide show
  1. package/CHANGELOG.md +64 -7
  2. package/dist/index.d.ts +829 -94
  3. package/lib/AreaChart.js +1 -0
  4. package/lib/AreaChart.js.map +1 -0
  5. package/lib/HeatMapChart.js +1 -0
  6. package/lib/HeatMapChart.js.map +1 -0
  7. package/lib/HorizontalBarChartWithAxis.js +1 -0
  8. package/lib/HorizontalBarChartWithAxis.js.map +1 -0
  9. package/lib/SankeyChart.js +1 -0
  10. package/lib/SankeyChart.js.map +1 -0
  11. package/lib/VerticalStackedBarChart.js +1 -0
  12. package/lib/VerticalStackedBarChart.js.map +1 -0
  13. package/lib/components/AreaChart/AreaChart.js +775 -0
  14. package/lib/components/AreaChart/AreaChart.js.map +1 -0
  15. package/lib/components/AreaChart/AreaChart.types.js +4 -0
  16. package/lib/components/AreaChart/AreaChart.types.js.map +1 -0
  17. package/lib/components/AreaChart/index.js +3 -0
  18. package/lib/components/AreaChart/index.js.map +1 -0
  19. package/lib/components/AreaChart/useAreaChartStyles.styles.js +55 -0
  20. package/lib/components/AreaChart/useAreaChartStyles.styles.js.map +1 -0
  21. package/lib/components/CommonComponents/CartesianChart.js +30 -14
  22. package/lib/components/CommonComponents/CartesianChart.js.map +1 -1
  23. package/lib/components/CommonComponents/CartesianChart.types.js.map +1 -1
  24. package/lib/components/CommonComponents/ChartPopover.js +2 -2
  25. package/lib/components/CommonComponents/ChartPopover.js.map +1 -1
  26. package/lib/components/CommonComponents/useCartesianChartStyles.styles.js +7 -123
  27. package/lib/components/CommonComponents/useCartesianChartStyles.styles.js.map +1 -1
  28. package/lib/components/CommonComponents/useChartPopoverStyles.styles.js +11 -22
  29. package/lib/components/CommonComponents/useChartPopoverStyles.styles.js.map +1 -1
  30. package/lib/components/DeclarativeChart/DeclarativeChart.js +112 -65
  31. package/lib/components/DeclarativeChart/DeclarativeChart.js.map +1 -1
  32. package/lib/components/DeclarativeChart/PlotlySchemaAdapter.js +570 -159
  33. package/lib/components/DeclarativeChart/PlotlySchemaAdapter.js.map +1 -1
  34. package/lib/components/DonutChart/Arc/Arc.js +1 -1
  35. package/lib/components/DonutChart/Arc/Arc.js.map +1 -1
  36. package/lib/components/DonutChart/DonutChart.js +1 -1
  37. package/lib/components/DonutChart/DonutChart.js.map +1 -1
  38. package/lib/components/DonutChart/Pie/usePieStyles.styles.js +2 -6
  39. package/lib/components/DonutChart/Pie/usePieStyles.styles.js.map +1 -1
  40. package/lib/components/GaugeChart/GaugeChart.js +4 -1
  41. package/lib/components/GaugeChart/GaugeChart.js.map +1 -1
  42. package/lib/components/GaugeChart/GaugeChart.types.js.map +1 -1
  43. package/lib/components/GaugeChart/useGaugeChartStyles.styles.js +13 -9
  44. package/lib/components/GaugeChart/useGaugeChartStyles.styles.js.map +1 -1
  45. package/lib/components/GroupedVerticalBarChart/GroupedVerticalBarChart.js +9 -0
  46. package/lib/components/GroupedVerticalBarChart/GroupedVerticalBarChart.js.map +1 -1
  47. package/lib/components/GroupedVerticalBarChart/useGroupedVerticalBarChartStyles.styles.js +0 -9
  48. package/lib/components/GroupedVerticalBarChart/useGroupedVerticalBarChartStyles.styles.js.map +1 -1
  49. package/lib/components/HeatMapChart/HeatMapChart.js +588 -0
  50. package/lib/components/HeatMapChart/HeatMapChart.js.map +1 -0
  51. package/lib/components/HeatMapChart/HeatMapChart.types.js +4 -0
  52. package/lib/components/HeatMapChart/HeatMapChart.types.js.map +1 -0
  53. package/lib/components/HeatMapChart/index.js +3 -0
  54. package/lib/components/HeatMapChart/index.js.map +1 -0
  55. package/lib/components/HeatMapChart/useHeatMapChartStyles.styles.js +37 -0
  56. package/lib/components/HeatMapChart/useHeatMapChartStyles.styles.js.map +1 -0
  57. package/lib/components/HorizontalBarChart/useHorizontalBarChartStyles.styles.js +2 -9
  58. package/lib/components/HorizontalBarChart/useHorizontalBarChartStyles.styles.js.map +1 -1
  59. package/lib/components/HorizontalBarChartWithAxis/HorizontalBarChartWithAxis.js +571 -0
  60. package/lib/components/HorizontalBarChartWithAxis/HorizontalBarChartWithAxis.js.map +1 -0
  61. package/lib/components/HorizontalBarChartWithAxis/HorizontalBarChartWithAxis.types.js +4 -0
  62. package/lib/components/HorizontalBarChartWithAxis/HorizontalBarChartWithAxis.types.js.map +1 -0
  63. package/lib/components/HorizontalBarChartWithAxis/index.js +3 -0
  64. package/lib/components/HorizontalBarChartWithAxis/index.js.map +1 -0
  65. package/lib/components/HorizontalBarChartWithAxis/useHorizontalBarChartWithAxisStyles.styles.js +67 -0
  66. package/lib/components/HorizontalBarChartWithAxis/useHorizontalBarChartWithAxisStyles.styles.js.map +1 -0
  67. package/lib/components/Legends/Legends.js +38 -37
  68. package/lib/components/Legends/Legends.js.map +1 -1
  69. package/lib/components/Legends/useLegendsStyles.styles.js +2 -3
  70. package/lib/components/Legends/useLegendsStyles.styles.js.map +1 -1
  71. package/lib/components/LineChart/LineChart.js +43 -35
  72. package/lib/components/LineChart/LineChart.js.map +1 -1
  73. package/lib/components/LineChart/useLineChartStyles.styles.js +1 -10
  74. package/lib/components/LineChart/useLineChartStyles.styles.js.map +1 -1
  75. package/lib/components/SankeyChart/SankeyChart.js +1023 -0
  76. package/lib/components/SankeyChart/SankeyChart.js.map +1 -0
  77. package/lib/components/SankeyChart/SankeyChart.types.js +3 -0
  78. package/lib/components/SankeyChart/SankeyChart.types.js.map +1 -0
  79. package/lib/components/SankeyChart/index.js +3 -0
  80. package/lib/components/SankeyChart/index.js.map +1 -0
  81. package/lib/components/SankeyChart/useSankeyChartStyles.styles.js +109 -0
  82. package/lib/components/SankeyChart/useSankeyChartStyles.styles.js.map +1 -0
  83. package/lib/components/ScatterChart/ScatterChart.js +46 -59
  84. package/lib/components/ScatterChart/ScatterChart.js.map +1 -1
  85. package/lib/components/ScatterChart/useScatterChartStyles.styles.js +1 -10
  86. package/lib/components/ScatterChart/useScatterChartStyles.styles.js.map +1 -1
  87. package/lib/components/VerticalBarChart/VerticalBarChart.js +165 -88
  88. package/lib/components/VerticalBarChart/VerticalBarChart.js.map +1 -1
  89. package/lib/components/VerticalBarChart/VerticalBarChart.types.js.map +1 -1
  90. package/lib/components/VerticalBarChart/useVerticalBarChartStyles.styles.js +3 -11
  91. package/lib/components/VerticalBarChart/useVerticalBarChartStyles.styles.js.map +1 -1
  92. package/lib/components/VerticalStackedBarChart/VerticalStackedBarChart.js +904 -0
  93. package/lib/components/VerticalStackedBarChart/VerticalStackedBarChart.js.map +1 -0
  94. package/lib/components/VerticalStackedBarChart/VerticalStackedBarChart.types.js +1 -0
  95. package/lib/components/VerticalStackedBarChart/VerticalStackedBarChart.types.js.map +1 -0
  96. package/lib/components/VerticalStackedBarChart/index.js +3 -0
  97. package/lib/components/VerticalStackedBarChart/index.js.map +1 -0
  98. package/lib/components/VerticalStackedBarChart/useVerticalStackedBarChartStyles.styles.js +65 -0
  99. package/lib/components/VerticalStackedBarChart/useVerticalStackedBarChartStyles.styles.js.map +1 -0
  100. package/lib/index.js +5 -0
  101. package/lib/index.js.map +1 -1
  102. package/lib/types/DataPoint.js +1 -3
  103. package/lib/types/DataPoint.js.map +1 -1
  104. package/lib/utilities/SVGTooltipText.js +49 -4
  105. package/lib/utilities/SVGTooltipText.js.map +1 -1
  106. package/lib/utilities/colors.js +20 -0
  107. package/lib/utilities/colors.js.map +1 -1
  108. package/lib/utilities/string.js +32 -0
  109. package/lib/utilities/string.js.map +1 -0
  110. package/lib/utilities/test-data.js +53 -0
  111. package/lib/utilities/test-data.js.map +1 -1
  112. package/lib/utilities/utilities.js +90 -18
  113. package/lib/utilities/utilities.js.map +1 -1
  114. package/lib-commonjs/AreaChart.js +6 -0
  115. package/lib-commonjs/AreaChart.js.map +1 -0
  116. package/lib-commonjs/HeatMapChart.js +6 -0
  117. package/lib-commonjs/HeatMapChart.js.map +1 -0
  118. package/lib-commonjs/HorizontalBarChartWithAxis.js +6 -0
  119. package/lib-commonjs/HorizontalBarChartWithAxis.js.map +1 -0
  120. package/lib-commonjs/SankeyChart.js +6 -0
  121. package/lib-commonjs/SankeyChart.js.map +1 -0
  122. package/lib-commonjs/VerticalStackedBarChart.js +6 -0
  123. package/lib-commonjs/VerticalStackedBarChart.js.map +1 -0
  124. package/lib-commonjs/components/AreaChart/AreaChart.js +781 -0
  125. package/lib-commonjs/components/AreaChart/AreaChart.js.map +1 -0
  126. package/lib-commonjs/components/AreaChart/AreaChart.types.js +7 -0
  127. package/lib-commonjs/components/AreaChart/AreaChart.types.js.map +1 -0
  128. package/lib-commonjs/components/AreaChart/index.js +8 -0
  129. package/lib-commonjs/components/AreaChart/index.js.map +1 -0
  130. package/lib-commonjs/components/AreaChart/useAreaChartStyles.styles.js +95 -0
  131. package/lib-commonjs/components/AreaChart/useAreaChartStyles.styles.js.map +1 -0
  132. package/lib-commonjs/components/CommonComponents/CartesianChart.js +29 -14
  133. package/lib-commonjs/components/CommonComponents/CartesianChart.js.map +1 -1
  134. package/lib-commonjs/components/CommonComponents/CartesianChart.types.js.map +1 -1
  135. package/lib-commonjs/components/CommonComponents/ChartPopover.js +2 -2
  136. package/lib-commonjs/components/CommonComponents/ChartPopover.js.map +1 -1
  137. package/lib-commonjs/components/CommonComponents/useCartesianChartStyles.styles.js +8 -198
  138. package/lib-commonjs/components/CommonComponents/useCartesianChartStyles.styles.js.map +1 -1
  139. package/lib-commonjs/components/CommonComponents/useChartPopoverStyles.styles.js +12 -37
  140. package/lib-commonjs/components/CommonComponents/useChartPopoverStyles.styles.js.map +1 -1
  141. package/lib-commonjs/components/DeclarativeChart/DeclarativeChart.js +120 -73
  142. package/lib-commonjs/components/DeclarativeChart/DeclarativeChart.js.map +1 -1
  143. package/lib-commonjs/components/DeclarativeChart/PlotlySchemaAdapter.js +592 -178
  144. package/lib-commonjs/components/DeclarativeChart/PlotlySchemaAdapter.js.map +1 -1
  145. package/lib-commonjs/components/DonutChart/Arc/Arc.js +1 -1
  146. package/lib-commonjs/components/DonutChart/Arc/Arc.js.map +1 -1
  147. package/lib-commonjs/components/DonutChart/DonutChart.js +1 -1
  148. package/lib-commonjs/components/DonutChart/DonutChart.js.map +1 -1
  149. package/lib-commonjs/components/DonutChart/Pie/usePieStyles.styles.js +3 -10
  150. package/lib-commonjs/components/DonutChart/Pie/usePieStyles.styles.js.map +1 -1
  151. package/lib-commonjs/components/GaugeChart/GaugeChart.js +4 -1
  152. package/lib-commonjs/components/GaugeChart/GaugeChart.js.map +1 -1
  153. package/lib-commonjs/components/GaugeChart/GaugeChart.types.js.map +1 -1
  154. package/lib-commonjs/components/GaugeChart/useGaugeChartStyles.styles.js +14 -8
  155. package/lib-commonjs/components/GaugeChart/useGaugeChartStyles.styles.js.map +1 -1
  156. package/lib-commonjs/components/GroupedVerticalBarChart/GroupedVerticalBarChart.js +9 -0
  157. package/lib-commonjs/components/GroupedVerticalBarChart/GroupedVerticalBarChart.js.map +1 -1
  158. package/lib-commonjs/components/GroupedVerticalBarChart/useGroupedVerticalBarChartStyles.styles.js +0 -9
  159. package/lib-commonjs/components/GroupedVerticalBarChart/useGroupedVerticalBarChartStyles.styles.js.map +1 -1
  160. package/lib-commonjs/components/HeatMapChart/HeatMapChart.js +599 -0
  161. package/lib-commonjs/components/HeatMapChart/HeatMapChart.js.map +1 -0
  162. package/lib-commonjs/components/HeatMapChart/HeatMapChart.types.js +7 -0
  163. package/lib-commonjs/components/HeatMapChart/HeatMapChart.types.js.map +1 -0
  164. package/lib-commonjs/components/HeatMapChart/index.js +8 -0
  165. package/lib-commonjs/components/HeatMapChart/index.js.map +1 -0
  166. package/lib-commonjs/components/HeatMapChart/useHeatMapChartStyles.styles.js +59 -0
  167. package/lib-commonjs/components/HeatMapChart/useHeatMapChartStyles.styles.js.map +1 -0
  168. package/lib-commonjs/components/HorizontalBarChart/useHorizontalBarChartStyles.styles.js +2 -16
  169. package/lib-commonjs/components/HorizontalBarChart/useHorizontalBarChartStyles.styles.js.map +1 -1
  170. package/lib-commonjs/components/HorizontalBarChartWithAxis/HorizontalBarChartWithAxis.js +580 -0
  171. package/lib-commonjs/components/HorizontalBarChartWithAxis/HorizontalBarChartWithAxis.js.map +1 -0
  172. package/lib-commonjs/components/HorizontalBarChartWithAxis/HorizontalBarChartWithAxis.types.js +7 -0
  173. package/lib-commonjs/components/HorizontalBarChartWithAxis/HorizontalBarChartWithAxis.types.js.map +1 -0
  174. package/lib-commonjs/components/HorizontalBarChartWithAxis/index.js +8 -0
  175. package/lib-commonjs/components/HorizontalBarChartWithAxis/index.js.map +1 -0
  176. package/lib-commonjs/components/HorizontalBarChartWithAxis/useHorizontalBarChartWithAxisStyles.styles.js +107 -0
  177. package/lib-commonjs/components/HorizontalBarChartWithAxis/useHorizontalBarChartWithAxisStyles.styles.js.map +1 -0
  178. package/lib-commonjs/components/Legends/Legends.js +37 -37
  179. package/lib-commonjs/components/Legends/Legends.js.map +1 -1
  180. package/lib-commonjs/components/Legends/useLegendsStyles.styles.js +2 -2
  181. package/lib-commonjs/components/Legends/useLegendsStyles.styles.js.map +1 -1
  182. package/lib-commonjs/components/LineChart/LineChart.js +41 -33
  183. package/lib-commonjs/components/LineChart/LineChart.js.map +1 -1
  184. package/lib-commonjs/components/LineChart/useLineChartStyles.styles.js +1 -10
  185. package/lib-commonjs/components/LineChart/useLineChartStyles.styles.js.map +1 -1
  186. package/lib-commonjs/components/SankeyChart/SankeyChart.js +1039 -0
  187. package/lib-commonjs/components/SankeyChart/SankeyChart.js.map +1 -0
  188. package/lib-commonjs/components/SankeyChart/SankeyChart.types.js +6 -0
  189. package/lib-commonjs/components/SankeyChart/SankeyChart.types.js.map +1 -0
  190. package/lib-commonjs/components/SankeyChart/index.js +8 -0
  191. package/lib-commonjs/components/SankeyChart/index.js.map +1 -0
  192. package/lib-commonjs/components/SankeyChart/useSankeyChartStyles.styles.js +179 -0
  193. package/lib-commonjs/components/SankeyChart/useSankeyChartStyles.styles.js.map +1 -0
  194. package/lib-commonjs/components/ScatterChart/ScatterChart.js +45 -58
  195. package/lib-commonjs/components/ScatterChart/ScatterChart.js.map +1 -1
  196. package/lib-commonjs/components/ScatterChart/useScatterChartStyles.styles.js +1 -10
  197. package/lib-commonjs/components/ScatterChart/useScatterChartStyles.styles.js.map +1 -1
  198. package/lib-commonjs/components/VerticalBarChart/VerticalBarChart.js +164 -87
  199. package/lib-commonjs/components/VerticalBarChart/VerticalBarChart.js.map +1 -1
  200. package/lib-commonjs/components/VerticalBarChart/VerticalBarChart.types.js.map +1 -1
  201. package/lib-commonjs/components/VerticalBarChart/useVerticalBarChartStyles.styles.js +4 -11
  202. package/lib-commonjs/components/VerticalBarChart/useVerticalBarChartStyles.styles.js.map +1 -1
  203. package/lib-commonjs/components/VerticalStackedBarChart/VerticalStackedBarChart.js +915 -0
  204. package/lib-commonjs/components/VerticalStackedBarChart/VerticalStackedBarChart.js.map +1 -0
  205. package/lib-commonjs/components/VerticalStackedBarChart/VerticalStackedBarChart.types.js +6 -0
  206. package/lib-commonjs/components/VerticalStackedBarChart/VerticalStackedBarChart.types.js.map +1 -0
  207. package/lib-commonjs/components/VerticalStackedBarChart/index.js +8 -0
  208. package/lib-commonjs/components/VerticalStackedBarChart/index.js.map +1 -0
  209. package/lib-commonjs/components/VerticalStackedBarChart/useVerticalStackedBarChartStyles.styles.js +113 -0
  210. package/lib-commonjs/components/VerticalStackedBarChart/useVerticalStackedBarChartStyles.styles.js.map +1 -0
  211. package/lib-commonjs/index.js +5 -0
  212. package/lib-commonjs/index.js.map +1 -1
  213. package/lib-commonjs/types/DataPoint.js +1 -3
  214. package/lib-commonjs/types/DataPoint.js.map +1 -1
  215. package/lib-commonjs/utilities/SVGTooltipText.js +49 -4
  216. package/lib-commonjs/utilities/SVGTooltipText.js.map +1 -1
  217. package/lib-commonjs/utilities/colors.js +23 -0
  218. package/lib-commonjs/utilities/colors.js.map +1 -1
  219. package/lib-commonjs/utilities/string.js +29 -0
  220. package/lib-commonjs/utilities/string.js.map +1 -0
  221. package/lib-commonjs/utilities/test-data.js +59 -0
  222. package/lib-commonjs/utilities/test-data.js.map +1 -1
  223. package/lib-commonjs/utilities/utilities.js +94 -17
  224. package/lib-commonjs/utilities/utilities.js.map +1 -1
  225. package/package.json +11 -8
  226. package/lib/components/DeclarativeChart/PlotlySchema.js +0 -7
  227. package/lib/components/DeclarativeChart/PlotlySchema.js.map +0 -1
  228. package/lib-commonjs/components/DeclarativeChart/PlotlySchema.js +0 -10
  229. package/lib-commonjs/components/DeclarativeChart/PlotlySchema.js.map +0 -1
package/dist/index.d.ts CHANGED
@@ -1,6 +1,12 @@
1
1
  /// <reference types="react" />
2
2
 
3
+ import { CurveFactory } from 'd3-shape';
3
4
  import * as React_2 from 'react';
5
+ import { RefObject } from 'react';
6
+ import { SankeyGraph } from 'd3-sankey';
7
+ import { SankeyLayout } from 'd3-sankey';
8
+ import { SankeyLink } from 'd3-sankey';
9
+ import { SankeyNode } from 'd3-sankey';
4
10
  import { SVGProps } from 'react';
5
11
  import { TimeLocaleDefinition } from 'd3-time-format';
6
12
 
@@ -22,8 +28,83 @@ export declare interface AccessibilityProps {
22
28
  ariaDescribedBy?: string;
23
29
  }
24
30
 
31
+ /**
32
+ * This is used to introduce dynamic padding for cases where the number of nodes in a column is huge
33
+ * so that we maintain a node to space ratio for such columns as if we fail to do so the
34
+ * chart is devoid of nodes and only shows links.
35
+ */
36
+ export declare function adjustPadding(sankey: SankeyLayoutGenerator, height: number, nodesInColumn: NodesInColumns): void;
37
+
25
38
  export declare const ARC_PADDING = 2;
26
39
 
40
+ export declare const AreaChart: React_2.FunctionComponent<AreaChartProps>;
41
+
42
+ export declare interface AreaChartAreaPoint {
43
+ xVal: string | number;
44
+ values: AreaChartDataSetPoint;
45
+ }
46
+
47
+ export declare interface AreaChartDataSetPoint {
48
+ [key: string]: number | string | number[];
49
+ }
50
+
51
+ /**
52
+ * Area Chart properties.
53
+ * {@docCategory AreaChart}
54
+ */
55
+ export declare interface AreaChartProps extends CartesianChartProps {
56
+ /**
57
+ * Data to render in the chart.
58
+ */
59
+ data: ChartProps;
60
+ /**
61
+ * Call to provide customized styling that will layer on top of the variant rules.
62
+ */
63
+ styles?: CartesianChartStyles;
64
+ /**
65
+ * Define a custom callout renderer for a data point
66
+ */
67
+ onRenderCalloutPerDataPoint?: RenderFunction<CustomizedCalloutData>;
68
+ /**
69
+ * Define a custom callout renderer for a stack; default is to render per data point
70
+ */
71
+ onRenderCalloutPerStack?: RenderFunction<CustomizedCalloutData>;
72
+ /**
73
+ * The prop used to define the culture to localized the numbers
74
+ */
75
+ culture?: string;
76
+ /**
77
+ * @default false
78
+ * The prop used to enable the perf optimization
79
+ */
80
+ enablePerfOptimization?: boolean;
81
+ optimizeLargeData?: boolean;
82
+ /**
83
+ * @default false
84
+ * The prop used to enable gradient fill color for the chart.
85
+ */
86
+ enableGradient?: boolean;
87
+ /**
88
+ * @default tonexty
89
+ * The prop used to define the Y axis mode (tonexty or tozeroy)
90
+ */
91
+ mode?: 'tozeroy' | 'tonexty';
92
+ }
93
+
94
+ /**
95
+ * Area Chart style properties
96
+ * {@docCategory AreaChart}
97
+ */
98
+ export declare interface AreaChartStyleProps extends CartesianChartStyleProps {
99
+ }
100
+
101
+ /**
102
+ * Area Chart styles
103
+ * {@docCategory AreaChart}
104
+ */
105
+ export declare interface AreaChartStyles extends CartesianChartStyles {
106
+ }
107
+
27
108
  /**
28
109
  * {@docCategory ChartData}
29
110
  */
@@ -298,6 +379,11 @@ export declare interface CartesianChartProps {
298
379
  * @default true
299
380
  */
300
381
  useUTC?: string | boolean;
382
+ /**
383
+ * @default false
384
+ * The prop used to decide rounded ticks on y axis
385
+ */
386
+ roundedTicks?: boolean;
301
387
  /**
302
388
  * Determines whether overlapping x-axis tick labels should be hidden.
303
389
  * @default false
@@ -382,46 +468,10 @@ export declare interface CartesianChartStyles {
382
468
  * line hover box css
383
469
  */
384
470
  hover?: string;
385
- /**
386
- * styles for callout root-content
387
- */
388
- calloutContentRoot?: string;
389
- /**
390
- * styles for callout x-content
391
- */
392
- calloutContentX?: string;
393
- /**
394
- * styles for callout y-content
395
- */
396
- calloutContentY?: string;
397
471
  /**
398
472
  * styles for description message
399
473
  */
400
474
  descriptionMessage?: string;
401
- /**
402
- * styles for callout Date time container
403
- */
404
- calloutDateTimeContainer?: string;
405
- /**
406
- * styles for callout info container
407
- */
408
- calloutInfoContainer?: string;
409
- /**
410
- * styles for callout block container
411
- */
412
- calloutBlockContainer?: string;
413
- /**
414
- * Styles for callout block container when toDrawShape is false
415
- */
416
- calloutBlockContainertoDrawShapefalse?: string;
417
- /**
418
- * Styles for callout block container when toDrawShape is true
419
- */
420
- calloutBlockContainertoDrawShapetrue?: string;
421
- /**
422
- * styles for callout legend text
423
- */
424
- calloutlegendText?: string;
425
475
  /**
426
476
  * styles for tooltip
427
477
  */
@@ -563,6 +613,10 @@ export declare interface ChartProps {
563
613
  * data for the points in the line chart
564
614
  */
565
615
  lineChartData?: LineChartPoints[];
616
+ /**
617
+ * data for the points in the line chart
618
+ */
619
+ SankeyChartData?: SankeyChartData;
566
620
  /**
567
621
  * data for the points in the line chart
568
622
  */
@@ -860,6 +914,15 @@ export declare interface DonutChartStyles {
860
914
  chartWrapper?: string;
861
915
  }
862
916
 
917
+ export declare interface DPointType {
918
+ values: {
919
+ 0: number;
920
+ 1: number;
921
+ data: {};
922
+ };
923
+ xVal: number | Date;
924
+ }
925
+
863
926
  declare interface EventAnnotation {
864
927
  date: Date;
865
928
  event: string;
@@ -971,6 +1034,11 @@ export declare interface GaugeChartProps {
971
1034
  * @default false
972
1035
  */
973
1036
  roundCorners?: boolean;
1037
+ /**
1038
+ * Optional callback to access the Chart interface. Use this instead of ref for accessing
1039
+ * the public methods and properties of the component.
1040
+ */
1041
+ componentRef?: React.RefObject<Chart>;
974
1042
  }
975
1043
 
976
1044
  /**
@@ -1095,6 +1163,8 @@ export declare type GaugeValueFormat = 'percentage' | 'fraction';
1095
1163
 
1096
1164
  export declare const getChartValueLabel: (chartValue: number, minValue: number, maxValue: number, chartValueFormat?: GaugeValueFormat | ((sweepFraction: [number, number]) => string) | undefined, forCallout?: boolean) => string;
1097
1165
 
1166
+ export declare const getColorContrast: (c1: string, c2: string) => number;
1167
+
1098
1168
  export declare const getColorFromToken: (token: string, isDarkTheme?: boolean) => string;
1099
1169
 
1100
1170
  export declare const getNextColor: (index: number, offset?: number, isDarkTheme?: boolean) => string;
@@ -1211,6 +1281,11 @@ export declare interface GroupedVerticalBarChartStyles extends CartesianChartSty
1211
1281
  barLabel: string;
1212
1282
  }
1213
1283
 
1284
+ /**
1285
+ * This is used to group nodes by column index.
1286
+ */
1287
+ export declare function groupNodesByColumn(graph: SankeyChartData): NodesInColumns;
1288
+
1214
1289
  /**
1215
1290
  * {@docCategory ChartData}
1216
1291
  */
@@ -1275,6 +1350,161 @@ export declare interface GVSingleDataPoint {
1275
1350
  [key: string]: GVDataPoint;
1276
1351
  }
1277
1352
 
1353
+ export declare const HeatMapChart: React_2.FunctionComponent<HeatMapChartProps>;
1354
+
1355
+ /**
1356
+ * {@docCategory ChartData}
1357
+ */
1358
+ export declare interface HeatMapChartData {
1359
+ /**
1360
+ * name of the legend
1361
+ */
1362
+ legend: string;
1363
+ data: HeatMapChartDataPoint[];
1364
+ /**
1365
+ * This number will be used to get the color for the legend
1366
+ */
1367
+ value: number;
1368
+ }
1369
+
1370
+ export declare interface HeatMapChartDataPoint {
1371
+ x: string | Date | number;
1372
+ y: string | Date | number;
1373
+ value: number;
1374
+ /**
1375
+ * The value/ text to be rendered in the rectange
1376
+ */
1377
+ rectText?: string | number;
1378
+ /**
1379
+ * denomination to show in the callout
1380
+ */
1381
+ ratio?: [number, number];
1382
+ /**
1383
+ * description message to the callout
1384
+ */
1385
+ descriptionMessage?: string;
1386
+ /**
1387
+ * onClick action for each datapoint in the chart
1388
+ */
1389
+ onClick?: VoidFunction;
1390
+ /**
1391
+ * Accessibility data for callout
1392
+ */
1393
+ callOutAccessibilityData?: AccessibilityProps;
1394
+ }
1395
+
1396
+ /**
1397
+ * Heat Map Chart properties
1398
+ * {@docCategory HeatMapChart}
1399
+ */
1400
+ export declare interface HeatMapChartProps extends CartesianChartProps {
1401
+ /**
1402
+ * chart title for the chart
1403
+ */
1404
+ chartTitle?: string;
1405
+ /**
1406
+ * data to provide for Heat Map
1407
+ */
1408
+ data: HeatMapChartData[];
1409
+ /**
1410
+ * The domain value for the color scale,
1411
+ *
1412
+ */
1413
+ domainValuesForColorScale: number[];
1414
+ /**
1415
+ * The range values for the color scale,
1416
+ * fill the array with colors in hex format
1417
+ * note:- it should contain values exactly as many as values in the array
1418
+ * `domainValuesForColorScale`
1419
+ */
1420
+ rangeValuesForColorScale: string[];
1421
+ /**
1422
+ * date formatter of x axis,
1423
+ * if the x-axis data point are of date type then user can use this
1424
+ * prop to format the date
1425
+ * refer to https://github.com/d3/d3-time-format for string values
1426
+ * @default '%b/%d'
1427
+ */
1428
+ xAxisDateFormatString?: string;
1429
+ /**
1430
+ * date formatter of y axis,
1431
+ * if the y-axis data point are or date type then user can use this
1432
+ * prop to format the date
1433
+ * refer to https://github.com/d3/d3-time-format for string values
1434
+ * @default '%b/%d'
1435
+ */
1436
+ yAxisDateFormatString?: string;
1437
+ /**
1438
+ * number formatter of x axis
1439
+ * if the x-axis data pints are of number type then user can
1440
+ * use this prop to format the number
1441
+ * refer to https://github.com/d3/d3-format for string values
1442
+ * @default '.2~s'
1443
+ */
1444
+ xAxisNumberFormatString?: string;
1445
+ /**
1446
+ * number formatter of y axis
1447
+ * if the y-axis data pints are of number type then user can
1448
+ * use this prop to format the number
1449
+ * refer to https://github.com/d3/d3-format for string values
1450
+ * @default '.2~s'
1451
+ */
1452
+ yAxisNumberFormatString?: string;
1453
+ /**
1454
+ * string formatter for x-axis.
1455
+ * This prop only applies if the x-axis is of string type
1456
+ *
1457
+ * For the accessiblity reason we sort the x-axis data point given by the consumer in ascending
1458
+ * order and then render in the x-axis. this behaviour would force the order of the data points.
1459
+ * to overcome , user can give x-axis point names as p1 p2...etc and map those p1 and p2 to custom name.
1460
+ * behind the scene the charting will actually sort the p1 and p2 and then we can attach the custom
1461
+ * name to that point by using this prop, hence giving the us the flexiblity of the order in which
1462
+ * label should render
1463
+ *
1464
+ * see the example file for the usage of the prop
1465
+ */
1466
+ xAxisStringFormatter?: (point: string) => string;
1467
+ /**
1468
+ * string formatter for y-axis.
1469
+ * This prop only applies if the y-axis is of string type
1470
+ *
1471
+ * For the accessiblity reason we sort the x-axis data point given by the consumer in ascending
1472
+ * order and then render in the y-axis. this behaviour would force the order of the data points.
1473
+ * to overcome , user can give y-axis point names as p1 p2...etc and map those p1 and p2 to custom name.
1474
+ * behind the scene the charting will actually sort the p1 and p2 and then we can attach the custom
1475
+ * name to that point by using this prop, hence giving the us the flexiblity of the order in which
1476
+ * label should render
1477
+ *
1478
+ * see the exaple file for the usage of the prop
1479
+ */
1480
+ yAxisStringFormatter?: (point: string) => string;
1481
+ /**
1482
+ * Call to provide customized styling that will layer on top of the variant rules.
1483
+ */
1484
+ styles?: HeatMapChartStyles;
1485
+ /**
1486
+ * The prop used to define the culture to localized the numbers
1487
+ */
1488
+ culture?: string;
1489
+ /**
1490
+ *@default false
1491
+ *Used for showing complete y axis lables */
1492
+ showYAxisLables?: boolean;
1493
+ /**
1494
+ * @default alphabetical
1495
+ * The prop used to decide order of string axis labels */
1496
+ sortOrder?: 'none' | 'alphabetical';
1497
+ }
1498
+
1499
+ /**
1500
+ * Heat Map Chart styles
1501
+ * {@docCategory HeatMapChart}
1502
+ */
1503
+ export declare interface HeatMapChartStyles extends CartesianChartStyles {
1504
+ root?: string;
1505
+ text?: string;
1506
+ }
1507
+
1278
1508
  /**
1279
1509
  * HorizontalBarChart is the context wrapper and container for all HorizontalBarChart content/controls,
1280
1510
  * It has no direct style or slot opinions.
@@ -1439,6 +1669,8 @@ export declare enum HorizontalBarChartVariant {
1439
1669
  AbsoluteScale = "absolute-scale"
1440
1670
  }
1441
1671
 
1672
+ export declare const HorizontalBarChartWithAxis: React_2.FunctionComponent<HorizontalBarChartWithAxisProps>;
1673
+
1442
1674
  /**
1443
1675
  * {@docCategory ChartData}
1444
1676
  */
@@ -1482,88 +1714,210 @@ export declare interface HorizontalBarChartWithAxisDataPoint {
1482
1714
  }
1483
1715
 
1484
1716
  /**
1485
- * {@docCategory ChartData}
1717
+ * Horizontal Bar Chart with Axis properties
1718
+ * {@docCategory HorizontalBarChartWithAxis}
1486
1719
  */
1487
- export declare interface HorizontalDataPoint {
1720
+ export declare interface HorizontalBarChartWithAxisProps extends CartesianChartProps {
1488
1721
  /**
1489
- * Independent value of the data point, rendered along the x-axis.
1490
- * If x is a number, then each y-coordinate is plotted at its x-coordinate.
1491
- * If x is a string, then the data is evenly spaced along the x-axis.
1722
+ * Data to render in the chart.
1492
1723
  */
1493
- x: number;
1724
+ data?: HorizontalBarChartWithAxisDataPoint[];
1494
1725
  /**
1495
- * Total value of a single point bar chart.
1726
+ * Define a custom callout renderer for a data point.
1496
1727
  */
1497
- total?: number;
1498
- }
1499
-
1500
- /**
1501
- * {@docCategory DeclarativeChart}
1502
- */
1503
- export declare interface IDeclarativeChart {
1504
- exportAsImage: (opts?: ImageExportOptions) => Promise<string>;
1505
- }
1506
-
1507
- /**
1508
- * {@docCategory DeclarativeChart}
1509
- */
1510
- export declare interface ImageExportOptions {
1511
- width?: number;
1512
- height?: number;
1513
- scale?: number;
1514
- background?: string;
1515
- }
1516
-
1517
- /**
1518
- * @public
1519
- * ILegend interface
1520
- * {@docCategory Legends}
1521
- */
1522
- export declare interface Legend {
1728
+ onRenderCalloutPerDataPoint?: RenderFunction<HorizontalBarChartWithAxisDataPoint>;
1523
1729
  /**
1524
- * Defines the title of the legend
1730
+ * Width of each bar in the chart.
1525
1731
  */
1526
- title: string;
1732
+ barHeight?: number;
1527
1733
  /**
1528
- * Defines the function that is executed on clicking this legend
1734
+ * Colors from which to select the color of each bar.
1529
1735
  */
1530
- action?: VoidFunction;
1736
+ colors?: string[];
1531
1737
  /**
1532
- * Defines the function that is executed upon hovering over the legend
1738
+ * chart title for the chart
1533
1739
  */
1534
- hoverAction?: VoidFunction;
1740
+ chartTitle?: string;
1535
1741
  /**
1536
- * Defines the function that is executed upon moving the mouse away from the legend
1742
+ * This prop makes sure that all the bars are of same color.
1743
+ * it will take the first color from the array of colors in
1744
+ * prop `colors` or if `colors` prop is not given then default color is palette.blueLight
1745
+ * @default false
1537
1746
  */
1538
- onMouseOutAction?: (isLegendFocused?: boolean) => void;
1747
+ useSingleColor?: boolean;
1539
1748
  /**
1540
- * The color for the legend
1749
+ * Call to provide customized styling that will layer on top of the variant rules.
1541
1750
  */
1542
- color: string;
1751
+ styles?: HorizontalBarChartWithAxisStyles;
1543
1752
  /**
1544
- * The opacity of the legend color
1753
+ * The prop used to define the culture to localized the numbers
1545
1754
  */
1546
- opacity?: number;
1755
+ culture?: string;
1547
1756
  /**
1548
- * The shape for the legend
1757
+ * it's padding between bar's or lines in the graph
1549
1758
  */
1550
- shape?: LegendShape;
1759
+ yAxisPadding?: number;
1551
1760
  /**
1552
- * Indicated whether or not to apply stripe pattern
1761
+ *@default false
1762
+ *Used for to elipse y axis labes and show tooltip on x axis labels
1553
1763
  */
1554
- stripePattern?: boolean;
1764
+ showYAxisLablesTooltip?: boolean;
1555
1765
  /**
1556
- * Indicates if the legend belongs to a line in the Bar Chart
1557
- */
1558
- isLineLegendInBarChart?: boolean;
1559
- nativeButtonProps?: React_2.ButtonHTMLAttributes<HTMLButtonElement>;
1560
- }
1561
-
1562
- export declare interface LegendDataItem {
1766
+ *@default false
1767
+ *Used for showing complete y axis lables */
1768
+ showYAxisLables?: boolean;
1563
1769
  /**
1564
- * Text to be displayed for legend item.
1770
+ * @default false
1771
+ * The prop used to enable gradient fill color for the chart.
1565
1772
  */
1566
- legendText: string | number;
1773
+ enableGradient?: boolean;
1774
+ /**
1775
+ * @default false
1776
+ * The prop used to enable rounded corners for the bars.
1777
+ */
1778
+ roundCorners?: boolean;
1779
+ }
1780
+
1781
+ /**
1782
+ * Horizontal Bar Chart with Axis style properties
1783
+ * {@docCategory HorizontalBarChartWithAxis}
1784
+ */
1785
+ export declare interface HorizontalBarChartWithAxisStyleProps extends CartesianChartStyleProps {
1786
+ /**
1787
+ * color of the datapoint legend
1788
+ */
1789
+ legendColor?: string;
1790
+ }
1791
+
1792
+ /**
1793
+ * Horizontal Bar Chart with Axis styles
1794
+ * {@docCategory HorizontalBarChartWithAxis}
1795
+ */
1796
+ export declare interface HorizontalBarChartWithAxisStyles extends CartesianChartStyles {
1797
+ /**
1798
+ * Style for the chart label.
1799
+ *
1800
+ */
1801
+ chartLabel?: string;
1802
+ /**
1803
+ * Style for the line representing the domain of the x-axis.
1804
+ *
1805
+ */
1806
+ xAxisDomain?: string;
1807
+ /**
1808
+ * Style for the lines representing the ticks along the x-axis.
1809
+ *
1810
+ */
1811
+ xAxisTicks?: string;
1812
+ /**
1813
+ * Style for the text labeling each tick along the x-axis.
1814
+ *
1815
+ */
1816
+ xAxisText?: string;
1817
+ /**
1818
+ * Style for the line representing the domain of the y-axis.
1819
+ *
1820
+ */
1821
+ yAxisDomain?: string;
1822
+ /**
1823
+ * Style for the lines representing the ticks along the y-axis.
1824
+ *
1825
+ */
1826
+ yAxisTicks?: string;
1827
+ /**
1828
+ * Style for the text labeling each tick along the y-axis.
1829
+ *
1830
+ */
1831
+ yAxisText?: string;
1832
+ /**
1833
+ * Style to change the opacity of bars in dataviz when we hover on a single bar or legends
1834
+ */
1835
+ opacityChangeOnHover: string;
1836
+ }
1837
+
1838
+ /**
1839
+ * {@docCategory ChartData}
1840
+ */
1841
+ export declare interface HorizontalDataPoint {
1842
+ /**
1843
+ * Independent value of the data point, rendered along the x-axis.
1844
+ * If x is a number, then each y-coordinate is plotted at its x-coordinate.
1845
+ * If x is a string, then the data is evenly spaced along the x-axis.
1846
+ */
1847
+ x: number;
1848
+ /**
1849
+ * Total value of a single point bar chart.
1850
+ */
1851
+ total?: number;
1852
+ }
1853
+
1854
+ /**
1855
+ * {@docCategory DeclarativeChart}
1856
+ */
1857
+ export declare interface IDeclarativeChart {
1858
+ exportAsImage: (opts?: ImageExportOptions) => Promise<string>;
1859
+ }
1860
+
1861
+ /**
1862
+ * {@docCategory DeclarativeChart}
1863
+ */
1864
+ export declare interface ImageExportOptions {
1865
+ width?: number;
1866
+ height?: number;
1867
+ scale?: number;
1868
+ background?: string;
1869
+ }
1870
+
1871
+ /**
1872
+ * @public
1873
+ * ILegend interface
1874
+ * {@docCategory Legends}
1875
+ */
1876
+ export declare interface Legend {
1877
+ /**
1878
+ * Defines the title of the legend
1879
+ */
1880
+ title: string;
1881
+ /**
1882
+ * Defines the function that is executed on clicking this legend
1883
+ */
1884
+ action?: VoidFunction;
1885
+ /**
1886
+ * Defines the function that is executed upon hovering over the legend
1887
+ */
1888
+ hoverAction?: VoidFunction;
1889
+ /**
1890
+ * Defines the function that is executed upon moving the mouse away from the legend
1891
+ */
1892
+ onMouseOutAction?: (isLegendFocused?: boolean) => void;
1893
+ /**
1894
+ * The color for the legend
1895
+ */
1896
+ color: string;
1897
+ /**
1898
+ * The opacity of the legend color
1899
+ */
1900
+ opacity?: number;
1901
+ /**
1902
+ * The shape for the legend
1903
+ */
1904
+ shape?: LegendShape;
1905
+ /**
1906
+ * Indicated whether or not to apply stripe pattern
1907
+ */
1908
+ stripePattern?: boolean;
1909
+ /**
1910
+ * Indicates if the legend belongs to a line in the Bar Chart
1911
+ */
1912
+ isLineLegendInBarChart?: boolean;
1913
+ nativeButtonProps?: React_2.ButtonHTMLAttributes<HTMLButtonElement>;
1914
+ }
1915
+
1916
+ export declare interface LegendDataItem {
1917
+ /**
1918
+ * Text to be displayed for legend item.
1919
+ */
1920
+ legendText: string | number;
1567
1921
  /**
1568
1922
  * Color for the specific legend
1569
1923
  */
@@ -1814,6 +2168,11 @@ export declare interface LineChartLineOptions extends SVGProps<SVGPathElement> {
1814
2168
  * Color of border around the line. Default white.
1815
2169
  */
1816
2170
  lineBorderColor?: string;
2171
+ /**
2172
+ * Defines the type of interpolation used to render the line.
2173
+ * @default 'linear'
2174
+ */
2175
+ curve?: 'linear' | 'natural' | 'step' | 'stepAfter' | 'stepBefore' | CurveFactory;
1817
2176
  }
1818
2177
 
1819
2178
  /**
@@ -1965,6 +2324,15 @@ export declare interface LineDataInVerticalStackedBarChart {
1965
2324
  * False by default.
1966
2325
  */
1967
2326
  useSecondaryYScale?: boolean;
2327
+ /**
2328
+ * options for the line drawn
2329
+ */
2330
+ lineOptions?: LineChartLineOptions;
2331
+ }
2332
+
2333
+ export declare interface MapXToDataSet {
2334
+ [key: string]: LineChartDataPoint[];
2335
+ [key: number]: LineChartDataPoint[];
1968
2336
  }
1969
2337
 
1970
2338
  /**
@@ -2055,10 +2423,18 @@ export declare interface ModifiedCartesianChartProps extends CartesianChartProps
2055
2423
  * Children elements specific to derived chart types.
2056
2424
  */
2057
2425
  children(props: ChildProps): React_2.ReactNode;
2426
+ /**
2427
+ * To enable callout for individual bar or complete stack. Using for only Vertical stacked bar chart.
2428
+ * @default false
2429
+ * @type \{boolean \}
2430
+ */
2431
+ isCalloutForStack?: boolean;
2058
2432
  /** dataset values to find out domain of the String axis
2059
2433
  * Present using for only vertical stacked bar chart and grouped vertical bar chart
2060
2434
  */
2061
2435
  datasetForXAxisDomain?: string[];
2436
+ /** Own callout design */
2437
+ customizedCallout?: any;
2062
2438
  /**
2063
2439
  * if the data points for the y-axis is of type string, then we need to give this
2064
2440
  * prop to construct the y-axis
@@ -2095,6 +2471,10 @@ export declare interface ModifiedCartesianChartProps extends CartesianChartProps
2095
2471
  enableFirstRenderOptimization?: boolean;
2096
2472
  }
2097
2473
 
2474
+ declare type NodesInColumns = {
2475
+ [key: number]: SNode[];
2476
+ };
2477
+
2098
2478
  /**
2099
2479
  * we need to make sure that if we add any property to this, then
2100
2480
  * we need to also add that in pointTypes below and vise-versa
@@ -2128,6 +2508,12 @@ export declare interface PopoverComponentStyles {
2128
2508
  calloutContainer: string;
2129
2509
  }
2130
2510
 
2511
+ export declare function preRenderLayout(margins: Margins, containerWidth: number, containerHeight: number, isRtl: boolean): {
2512
+ sankey: SankeyLayoutGenerator;
2513
+ height: number;
2514
+ width: number;
2515
+ };
2516
+
2131
2517
  export declare interface RefArrayData {
2132
2518
  index?: string;
2133
2519
  refElement?: SVGGElement;
@@ -2151,6 +2537,158 @@ declare interface ResponsiveContainerProps {
2151
2537
  height?: number | string;
2152
2538
  }
2153
2539
 
2540
+ export declare const SankeyChart: React_2.FunctionComponent<SankeyChartProps>;
2541
+
2542
+ /**
2543
+ * Set of strings which are used when rendering accessibility information within the chart.
2544
+ */
2545
+ export declare interface SankeyChartAccessibilityProps {
2546
+ /**
2547
+ * Aria label for when the chart is empty.
2548
+ */
2549
+ emptyAriaLabel?: string;
2550
+ /**
2551
+ * A value similar to "node \{0\} with weight \{1\}".
2552
+ * \{0\} is the name of the node.
2553
+ * \{1\} is the weight of the node (as computed by the sankey layout engine via the links to or from this node).
2554
+ */
2555
+ nodeAriaLabel?: string;
2556
+ /**
2557
+ * A value similar to "link from \{0\} to $\{1\} with weight $\{2\}".
2558
+ * \{0\} is the source node, \{1\} is the target node, and \{2\} is the value of the link.
2559
+ */
2560
+ linkAriaLabel?: string;
2561
+ }
2562
+
2563
+ /**
2564
+ * {@docCategory ChartData}
2565
+ */
2566
+ export declare interface SankeyChartData {
2567
+ nodes: SNode[];
2568
+ links: SLink[];
2569
+ }
2570
+
2571
+ /**
2572
+ * Sankey Chart properties
2573
+ * {@docCategory SankeyChart}
2574
+ */
2575
+ export declare interface SankeyChartProps {
2576
+ /**
2577
+ * Data to render in the chart.
2578
+ */
2579
+ data: ChartProps;
2580
+ /**
2581
+ * Width of the chart.
2582
+ */
2583
+ width?: number;
2584
+ /**
2585
+ * Height of the chart.
2586
+ */
2587
+ height?: number;
2588
+ /**
2589
+ * Additional CSS class(es) to apply to the SankeyChart.
2590
+ */
2591
+ className?: string;
2592
+ /**
2593
+ * Call to provide customized styling that will layer on top of the variant rules.
2594
+ */
2595
+ styles?: SankeyChartStyles;
2596
+ /**
2597
+ * this prop takes its parent as a HTML element to define the width and height of the Sankey chart
2598
+ */
2599
+ parentRef?: HTMLElement | null;
2600
+ /**
2601
+ * should chart resize when parent resize.
2602
+ */
2603
+ shouldResize?: number;
2604
+ /**
2605
+ * Color for path
2606
+ */
2607
+ pathColor?: string;
2608
+ /**
2609
+ * Colors for nodes
2610
+ */
2611
+ colorsForNodes?: string[];
2612
+ /**
2613
+ * Colors for nodes border
2614
+ */
2615
+ borderColorsForNodes?: string[];
2616
+ /**
2617
+ * Localized strings to show in the UX.
2618
+ */
2619
+ strings?: SankeyChartStrings;
2620
+ /**
2621
+ * Localized strings to use for the chart's accessibility features.
2622
+ */
2623
+ accessibility?: SankeyChartAccessibilityProps;
2624
+ /**
2625
+ * Format node and link values.
2626
+ */
2627
+ formatNumberOptions?: Intl.NumberFormatOptions;
2628
+ /**
2629
+ * Prop to disable shrinking of the chart beyond a certain limit and enable scrolling when the chart overflows
2630
+ * @default true
2631
+ */
2632
+ enableReflow?: boolean;
2633
+ /**
2634
+ * Optional callback to access the Chart interface. Use this instead of ref for accessing
2635
+ * the public methods and properties of the component.
2636
+ */
2637
+ componentRef?: RefObject<Chart>;
2638
+ /**
2639
+ * props for the callout in the chart
2640
+ */
2641
+ calloutProps?: ChartPopoverProps;
2642
+ /**
2643
+ * The prop used to define the culture to localize the numbers and date
2644
+ */
2645
+ culture?: string;
2646
+ }
2647
+
2648
+ /**
2649
+ * Set of strings which are used when rendering the chart.
2650
+ */
2651
+ export declare interface SankeyChartStrings {
2652
+ /**
2653
+ * A value similar to "from \{0\}" where \{0\} is the name of the source node for a link.
2654
+ * This is shown in the `ChartHoverCard` when the user hovers the mouse over a link.
2655
+ */
2656
+ linkFrom?: string;
2657
+ }
2658
+
2659
+ /**
2660
+ * Sankey Chart styles
2661
+ * {@docCategory SankeyChart}
2662
+ */
2663
+ export declare interface SankeyChartStyles {
2664
+ /**
2665
+ * Style for the root element.
2666
+ */
2667
+ root?: string;
2668
+ /**
2669
+ * Style for the nodes.
2670
+ */
2671
+ nodes?: string;
2672
+ /**
2673
+ * Style for the links.
2674
+ */
2675
+ links?: string;
2676
+ /**
2677
+ * Style for the text inside node.
2678
+ */
2679
+ nodeTextContainer?: string;
2680
+ /**
2681
+ * Style for the tooltip ,when user hover over the truncated node detail.
2682
+ */
2683
+ toolTip?: string;
2684
+ /**
2685
+ * Styles for the chart wrapper div
2686
+ */
2687
+ chartWrapper?: string;
2688
+ }
2689
+
2690
+ declare type SankeyLayoutGenerator = SankeyLayout<SankeyGraph<{}, {}>, {}, {}>;
2691
+
2154
2692
  /**
2155
2693
  * ScatterChart component
2156
2694
  * {@docCategory ScatterChart}
@@ -2238,6 +2776,41 @@ export declare interface ShapeProps {
2238
2776
  style?: React_2.CSSProperties | undefined;
2239
2777
  }
2240
2778
 
2779
+ export declare type SLink = SankeyLink<SNodeExtra, SLinkExtra>;
2780
+
2781
+ declare interface SLinkExtra {
2782
+ /**
2783
+ * The index within `ISankeyChartData.nodes` of the source node.
2784
+ */
2785
+ source: number;
2786
+ /**
2787
+ * The index within `ISankeyChartData.nodes` of the target node.
2788
+ */
2789
+ target: number;
2790
+ /**
2791
+ * The weight of this link between the two nodes.
2792
+ */
2793
+ value: number;
2794
+ unnormalizedValue?: number;
2795
+ }
2796
+
2797
+ export declare type SNode = SankeyNode<SNodeExtra, SLinkExtra>;
2798
+
2799
+ declare interface SNodeExtra {
2800
+ /**
2801
+ * A unique identifier for this node.
2802
+ */
2803
+ nodeId: number | string;
2804
+ /**
2805
+ * The display name for this node in the UX.
2806
+ */
2807
+ name: string;
2808
+ color?: string;
2809
+ borderColor?: string;
2810
+ actualValue?: number;
2811
+ layer?: number;
2812
+ }
2813
+
2241
2814
  /**
2242
2815
  * Sparkline is the context wrapper and container for all Sparkline content/controls,
2243
2816
  * It has no direct style or slot opinions.
@@ -2446,6 +3019,21 @@ export declare interface VerticalBarChartProps extends CartesianChartProps {
2446
3019
  * Only applicable to string x-axis.
2447
3020
  */
2448
3021
  xAxisOuterPadding?: number;
3022
+ /**
3023
+ * @default false
3024
+ * The prop used to enable gradient fill color for the chart.
3025
+ */
3026
+ enableGradient?: boolean;
3027
+ /**
3028
+ * @default false
3029
+ * The prop used to enable rounded corners for the chart.
3030
+ */
3031
+ roundCorners?: boolean;
3032
+ /**
3033
+ * Specifies the mode of the chart.
3034
+ * @default 'default'
3035
+ */
3036
+ mode?: 'default' | 'plotly';
2449
3037
  }
2450
3038
 
2451
3039
  /**
@@ -2470,6 +3058,149 @@ export declare interface VerticalBarChartStyles extends CartesianChartStyles {
2470
3058
  barLabel: string;
2471
3059
  }
2472
3060
 
3061
+ export declare const VerticalStackedBarChart: React_2.FunctionComponent<VerticalStackedBarChartProps>;
3062
+
3063
+ /**
3064
+ * Vertical Stacked Bar Chart properties
3065
+ * {@docCategory VerticalStackedBarChart}
3066
+ */
3067
+ export declare interface VerticalStackedBarChartProps extends CartesianChartProps {
3068
+ /**
3069
+ * Data to render in the chart.
3070
+ */
3071
+ data: VerticalStackedChartProps[];
3072
+ /**
3073
+ * Width of each bar in the chart. When set to `undefined` or `'default'`, the bar width defaults to 16px,
3074
+ * which may decrease to prevent overlap. When set to `'auto'`, the bar width is calculated from padding values.
3075
+ */
3076
+ barWidth?: number | 'default' | 'auto';
3077
+ /**
3078
+ * Gap (max) between bars in a stack. When non-zero, the bars in a stack will
3079
+ * be separated by gaps. The actual size of each gap is calculated as 20% of
3080
+ * the height of that stack, with a minimum size of 1px and a maximum given by
3081
+ * this prop.
3082
+ * @default 0
3083
+ */
3084
+ barGapMax?: number;
3085
+ /**
3086
+ * Corner radius of the bars
3087
+ * @default 0
3088
+ */
3089
+ barCornerRadius?: number;
3090
+ /**
3091
+ * The minimum height of a bar; bars below this height will be displayed at
3092
+ * this height. Note that this setting will result in the height of these data
3093
+ * points not being to scale.
3094
+ * @default 0
3095
+ */
3096
+ barMinimumHeight?: number;
3097
+ /**
3098
+ * chart title for the chart
3099
+ */
3100
+ chartTitle?: string;
3101
+ /**
3102
+ * To display multi stack callout or single callout
3103
+ * @default flase
3104
+ */
3105
+ isCalloutForStack?: boolean;
3106
+ /**
3107
+ * Call to provide customized styling that will layer on top of the variant rules.
3108
+ */
3109
+ styles?: VerticalStackedBarChartStyles;
3110
+ /**
3111
+ * Define a custom callout renderer for a stack; default is to render per data point
3112
+ */
3113
+ onRenderCalloutPerStack?: RenderFunction<VerticalStackedChartProps>;
3114
+ /**
3115
+ * Define a custom callout renderer for a data point
3116
+ */
3117
+ onRenderCalloutPerDataPoint?: RenderFunction<VSChartDataPoint>;
3118
+ /**
3119
+ * yMinValue is not supported for bar charts, so only allow "undefined"
3120
+ */
3121
+ yMinValue?: undefined;
3122
+ /**
3123
+ * Allow hover actions on the legend
3124
+ * @default true
3125
+ */
3126
+ allowHoverOnLegend?: boolean;
3127
+ /**
3128
+ * Click handler for bars; type of data is dependant on isCalloutForStack
3129
+ */
3130
+ onBarClick?: (event: React_2.MouseEvent<SVGElement>, data: VerticalStackedChartProps | VSChartDataPoint) => void;
3131
+ /**
3132
+ * The prop used to define the culture to localized the numbers
3133
+ */
3134
+ culture?: string;
3135
+ /**
3136
+ * it's padding between bar's or lines in the graph
3137
+ */
3138
+ xAxisPadding?: number;
3139
+ /**
3140
+ * options for the line drawn
3141
+ */
3142
+ lineOptions?: LineChartLineOptions;
3143
+ /**
3144
+ * Prop to hide the bar labels
3145
+ * @default false
3146
+ */
3147
+ hideLabels?: boolean;
3148
+ /**
3149
+ * Maximum width of a bar, in pixels.
3150
+ * @default 24
3151
+ */
3152
+ maxBarWidth?: number;
3153
+ /**
3154
+ * Padding between bars as a fraction of the [step](https://d3js.org/d3-scale/band#band_step).
3155
+ * Takes a number in the range [0, 1]. Only applicable to string x-axis.
3156
+ * @default 2/3
3157
+ */
3158
+ xAxisInnerPadding?: number;
3159
+ /**
3160
+ * Padding before the first bar and after the last bar as a fraction of
3161
+ * the [step](https://d3js.org/d3-scale/band#band_step). Takes a number in the range [0, 1].
3162
+ * Only applicable to string x-axis.
3163
+ */
3164
+ xAxisOuterPadding?: number;
3165
+ /**
3166
+ * @default false
3167
+ * The prop used to enable gradient fill color for the chart.
3168
+ */
3169
+ enableGradient?: boolean;
3170
+ /**
3171
+ * @default false
3172
+ * The prop used to enable rounded corners for the chart.
3173
+ */
3174
+ roundCorners?: boolean;
3175
+ /**
3176
+ * Specifies the mode of the chart.
3177
+ * @default 'default'
3178
+ */
3179
+ mode?: 'default' | 'plotly';
3180
+ }
3181
+
3182
+ /**
3183
+ * Vertical Stacked Bar Chart style properties
3184
+ * {@docCategory VerticalStackedBarChart}
3185
+ */
3186
+ export declare interface VerticalStackedBarChartStyleProps extends CartesianChartStyleProps {
3187
+ }
3188
+
3189
+ /**
3190
+ * Vertical Stacked Bar Chart styles
3191
+ * {@docCategory VerticalStackedBarChart}
3192
+ */
3193
+ export declare interface VerticalStackedBarChartStyles extends CartesianChartStyles {
3194
+ /**
3195
+ * Style to change the opacity of bars in dataviz when we hover on a single bar or legends
3196
+ */
3197
+ opacityChangeOnHover?: string;
3198
+ /**
3199
+ * Style for the bar labels
3200
+ */
3201
+ barLabel: string;
3202
+ }
3203
+
2473
3204
  /**
2474
3205
  * {@docCategory ChartData}
2475
3206
  */
@@ -2540,6 +3271,10 @@ export declare interface VSChartDataPoint {
2540
3271
  * Accessibility data for callout
2541
3272
  */
2542
3273
  callOutAccessibilityData?: AccessibilityProps;
3274
+ /**
3275
+ * The prop used to define the culture to localized the numbers
3276
+ */
3277
+ culture?: string;
2543
3278
  }
2544
3279
 
2545
3280
  declare enum XAxisTypes {