@fluentui/react-charting 5.18.8 → 5.18.9

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 (257) hide show
  1. package/CHANGELOG.json +16 -1
  2. package/CHANGELOG.md +11 -2
  3. package/README.md +48 -80
  4. package/dist/react-charting.d.ts +277 -36
  5. package/dist/react-charting.js +1 -1
  6. package/dist/react-charting.min.js +1 -1
  7. package/docs/TechnicalDetails.md +88 -0
  8. package/etc/react-charting.api.md +41 -41
  9. package/lib/components/AreaChart/AreaChart.types.d.ts +9 -1
  10. package/lib/components/AreaChart/AreaChart.types.js.map +1 -1
  11. package/lib/components/CommonComponents/CartesianChart.d.ts +4 -0
  12. package/lib/components/CommonComponents/CartesianChart.js +4 -0
  13. package/lib/components/CommonComponents/CartesianChart.js.map +1 -1
  14. package/lib/components/CommonComponents/CartesianChart.types.d.ts +12 -0
  15. package/lib/components/CommonComponents/CartesianChart.types.js.map +1 -1
  16. package/lib/components/DonutChart/DonutChart.types.d.ts +9 -1
  17. package/lib/components/DonutChart/DonutChart.types.js.map +1 -1
  18. package/lib/components/GaugeChart/GaugeChart.types.d.ts +13 -2
  19. package/lib/components/GaugeChart/GaugeChart.types.js +3 -0
  20. package/lib/components/GaugeChart/GaugeChart.types.js.map +1 -1
  21. package/lib/components/GroupedVerticalBarChart/GroupedVerticalBarChart.types.d.ts +9 -1
  22. package/lib/components/GroupedVerticalBarChart/GroupedVerticalBarChart.types.js.map +1 -1
  23. package/lib/components/HeatMapChart/HeatMapChart.types.d.ts +9 -1
  24. package/lib/components/HeatMapChart/HeatMapChart.types.js.map +1 -1
  25. package/lib/components/HorizontalBarChart/HorizontalBarChart.types.d.ts +13 -1
  26. package/lib/components/HorizontalBarChart/HorizontalBarChart.types.js +3 -0
  27. package/lib/components/HorizontalBarChart/HorizontalBarChart.types.js.map +1 -1
  28. package/lib/components/HorizontalBarChartWithAxis/HorizontalBarChartWithAxis.types.d.ts +9 -1
  29. package/lib/components/HorizontalBarChartWithAxis/HorizontalBarChartWithAxis.types.js.map +1 -1
  30. package/lib/components/Legends/Legends.d.ts +1 -1
  31. package/lib/components/Legends/Legends.js +1 -1
  32. package/lib/components/Legends/Legends.js.map +1 -1
  33. package/lib/components/Legends/Legends.types.d.ts +14 -8
  34. package/lib/components/Legends/Legends.types.js.map +1 -1
  35. package/lib/components/LineChart/LineChart.d.ts +1 -1
  36. package/lib/components/LineChart/LineChart.js +1 -1
  37. package/lib/components/LineChart/LineChart.js.map +1 -1
  38. package/lib/components/LineChart/LineChart.types.d.ts +18 -1
  39. package/lib/components/LineChart/LineChart.types.js.map +1 -1
  40. package/lib/components/PieChart/PieChart.d.ts +1 -1
  41. package/lib/components/PieChart/PieChart.js +1 -1
  42. package/lib/components/PieChart/PieChart.js.map +1 -1
  43. package/lib/components/PieChart/PieChart.types.d.ts +9 -1
  44. package/lib/components/PieChart/PieChart.types.js.map +1 -1
  45. package/lib/components/SankeyChart/SankeyChart.d.ts +1 -1
  46. package/lib/components/SankeyChart/SankeyChart.js +1 -1
  47. package/lib/components/SankeyChart/SankeyChart.js.map +1 -1
  48. package/lib/components/SankeyChart/SankeyChart.types.d.ts +9 -1
  49. package/lib/components/SankeyChart/SankeyChart.types.js.map +1 -1
  50. package/lib/components/Sparkline/Sparkline.d.ts +1 -1
  51. package/lib/components/Sparkline/Sparkline.js +1 -1
  52. package/lib/components/Sparkline/Sparkline.js.map +1 -1
  53. package/lib/components/Sparkline/Sparkline.types.d.ts +6 -2
  54. package/lib/components/Sparkline/Sparkline.types.js.map +1 -1
  55. package/lib/components/StackedBarChart/MultiStackedBarChart.d.ts +1 -1
  56. package/lib/components/StackedBarChart/MultiStackedBarChart.js +1 -1
  57. package/lib/components/StackedBarChart/MultiStackedBarChart.js.map +1 -1
  58. package/lib/components/StackedBarChart/MultiStackedBarChart.types.d.ts +12 -1
  59. package/lib/components/StackedBarChart/MultiStackedBarChart.types.js +3 -0
  60. package/lib/components/StackedBarChart/MultiStackedBarChart.types.js.map +1 -1
  61. package/lib/components/StackedBarChart/StackedBarChart.d.ts +1 -1
  62. package/lib/components/StackedBarChart/StackedBarChart.js +1 -1
  63. package/lib/components/StackedBarChart/StackedBarChart.js.map +1 -1
  64. package/lib/components/StackedBarChart/StackedBarChart.types.d.ts +9 -1
  65. package/lib/components/StackedBarChart/StackedBarChart.types.js.map +1 -1
  66. package/lib/components/TreeChart/TreeChart.d.ts +1 -1
  67. package/lib/components/TreeChart/TreeChart.js +1 -1
  68. package/lib/components/TreeChart/TreeChart.js.map +1 -1
  69. package/lib/components/TreeChart/TreeChart.types.d.ts +18 -1
  70. package/lib/components/TreeChart/TreeChart.types.js +6 -0
  71. package/lib/components/TreeChart/TreeChart.types.js.map +1 -1
  72. package/lib/components/VerticalBarChart/VerticalBarChart.d.ts +1 -1
  73. package/lib/components/VerticalBarChart/VerticalBarChart.js +1 -1
  74. package/lib/components/VerticalBarChart/VerticalBarChart.js.map +1 -1
  75. package/lib/components/VerticalBarChart/VerticalBarChart.types.d.ts +9 -1
  76. package/lib/components/VerticalBarChart/VerticalBarChart.types.js.map +1 -1
  77. package/lib/components/VerticalStackedBarChart/VerticalStackedBarChart.d.ts +1 -1
  78. package/lib/components/VerticalStackedBarChart/VerticalStackedBarChart.js +1 -1
  79. package/lib/components/VerticalStackedBarChart/VerticalStackedBarChart.js.map +1 -1
  80. package/lib/components/VerticalStackedBarChart/VerticalStackedBarChart.types.d.ts +9 -1
  81. package/lib/components/VerticalStackedBarChart/VerticalStackedBarChart.types.js.map +1 -1
  82. package/lib/types/IDataPoint.d.ts +67 -0
  83. package/lib/types/IDataPoint.js.map +1 -1
  84. package/lib/version.js +1 -1
  85. package/lib/version.js.map +1 -1
  86. package/lib-amd/components/AreaChart/AreaChart.types.d.ts +9 -1
  87. package/lib-amd/components/AreaChart/AreaChart.types.js.map +1 -1
  88. package/lib-amd/components/CommonComponents/CartesianChart.d.ts +4 -0
  89. package/lib-amd/components/CommonComponents/CartesianChart.js +4 -0
  90. package/lib-amd/components/CommonComponents/CartesianChart.js.map +1 -1
  91. package/lib-amd/components/CommonComponents/CartesianChart.types.d.ts +12 -0
  92. package/lib-amd/components/CommonComponents/CartesianChart.types.js.map +1 -1
  93. package/lib-amd/components/DonutChart/DonutChart.types.d.ts +9 -1
  94. package/lib-amd/components/DonutChart/DonutChart.types.js.map +1 -1
  95. package/lib-amd/components/GaugeChart/GaugeChart.types.d.ts +13 -2
  96. package/lib-amd/components/GaugeChart/GaugeChart.types.js +3 -0
  97. package/lib-amd/components/GaugeChart/GaugeChart.types.js.map +1 -1
  98. package/lib-amd/components/GroupedVerticalBarChart/GroupedVerticalBarChart.types.d.ts +9 -1
  99. package/lib-amd/components/GroupedVerticalBarChart/GroupedVerticalBarChart.types.js.map +1 -1
  100. package/lib-amd/components/HeatMapChart/HeatMapChart.types.d.ts +9 -1
  101. package/lib-amd/components/HeatMapChart/HeatMapChart.types.js.map +1 -1
  102. package/lib-amd/components/HorizontalBarChart/HorizontalBarChart.types.d.ts +13 -1
  103. package/lib-amd/components/HorizontalBarChart/HorizontalBarChart.types.js +3 -0
  104. package/lib-amd/components/HorizontalBarChart/HorizontalBarChart.types.js.map +1 -1
  105. package/lib-amd/components/HorizontalBarChartWithAxis/HorizontalBarChartWithAxis.types.d.ts +9 -1
  106. package/lib-amd/components/HorizontalBarChartWithAxis/HorizontalBarChartWithAxis.types.js.map +1 -1
  107. package/lib-amd/components/Legends/Legends.d.ts +1 -1
  108. package/lib-amd/components/Legends/Legends.js +1 -1
  109. package/lib-amd/components/Legends/Legends.js.map +1 -1
  110. package/lib-amd/components/Legends/Legends.types.d.ts +14 -8
  111. package/lib-amd/components/Legends/Legends.types.js.map +1 -1
  112. package/lib-amd/components/LineChart/LineChart.d.ts +1 -1
  113. package/lib-amd/components/LineChart/LineChart.js +1 -1
  114. package/lib-amd/components/LineChart/LineChart.js.map +1 -1
  115. package/lib-amd/components/LineChart/LineChart.types.d.ts +18 -1
  116. package/lib-amd/components/LineChart/LineChart.types.js.map +1 -1
  117. package/lib-amd/components/PieChart/PieChart.d.ts +1 -1
  118. package/lib-amd/components/PieChart/PieChart.js +1 -1
  119. package/lib-amd/components/PieChart/PieChart.js.map +1 -1
  120. package/lib-amd/components/PieChart/PieChart.types.d.ts +9 -1
  121. package/lib-amd/components/PieChart/PieChart.types.js.map +1 -1
  122. package/lib-amd/components/SankeyChart/SankeyChart.d.ts +1 -1
  123. package/lib-amd/components/SankeyChart/SankeyChart.js +1 -1
  124. package/lib-amd/components/SankeyChart/SankeyChart.js.map +1 -1
  125. package/lib-amd/components/SankeyChart/SankeyChart.types.d.ts +9 -1
  126. package/lib-amd/components/SankeyChart/SankeyChart.types.js.map +1 -1
  127. package/lib-amd/components/Sparkline/Sparkline.d.ts +1 -1
  128. package/lib-amd/components/Sparkline/Sparkline.js +1 -1
  129. package/lib-amd/components/Sparkline/Sparkline.js.map +1 -1
  130. package/lib-amd/components/Sparkline/Sparkline.types.d.ts +6 -2
  131. package/lib-amd/components/Sparkline/Sparkline.types.js.map +1 -1
  132. package/lib-amd/components/StackedBarChart/MultiStackedBarChart.d.ts +1 -1
  133. package/lib-amd/components/StackedBarChart/MultiStackedBarChart.js +1 -1
  134. package/lib-amd/components/StackedBarChart/MultiStackedBarChart.js.map +1 -1
  135. package/lib-amd/components/StackedBarChart/MultiStackedBarChart.types.d.ts +12 -1
  136. package/lib-amd/components/StackedBarChart/MultiStackedBarChart.types.js +3 -0
  137. package/lib-amd/components/StackedBarChart/MultiStackedBarChart.types.js.map +1 -1
  138. package/lib-amd/components/StackedBarChart/StackedBarChart.d.ts +1 -1
  139. package/lib-amd/components/StackedBarChart/StackedBarChart.js +1 -1
  140. package/lib-amd/components/StackedBarChart/StackedBarChart.js.map +1 -1
  141. package/lib-amd/components/StackedBarChart/StackedBarChart.types.d.ts +9 -1
  142. package/lib-amd/components/StackedBarChart/StackedBarChart.types.js.map +1 -1
  143. package/lib-amd/components/TreeChart/TreeChart.d.ts +1 -1
  144. package/lib-amd/components/TreeChart/TreeChart.js +1 -1
  145. package/lib-amd/components/TreeChart/TreeChart.js.map +1 -1
  146. package/lib-amd/components/TreeChart/TreeChart.types.d.ts +18 -1
  147. package/lib-amd/components/TreeChart/TreeChart.types.js +6 -0
  148. package/lib-amd/components/TreeChart/TreeChart.types.js.map +1 -1
  149. package/lib-amd/components/VerticalBarChart/VerticalBarChart.d.ts +1 -1
  150. package/lib-amd/components/VerticalBarChart/VerticalBarChart.js +1 -1
  151. package/lib-amd/components/VerticalBarChart/VerticalBarChart.js.map +1 -1
  152. package/lib-amd/components/VerticalBarChart/VerticalBarChart.types.d.ts +9 -1
  153. package/lib-amd/components/VerticalBarChart/VerticalBarChart.types.js.map +1 -1
  154. package/lib-amd/components/VerticalStackedBarChart/VerticalStackedBarChart.d.ts +1 -1
  155. package/lib-amd/components/VerticalStackedBarChart/VerticalStackedBarChart.js +1 -1
  156. package/lib-amd/components/VerticalStackedBarChart/VerticalStackedBarChart.js.map +1 -1
  157. package/lib-amd/components/VerticalStackedBarChart/VerticalStackedBarChart.types.d.ts +9 -1
  158. package/lib-amd/components/VerticalStackedBarChart/VerticalStackedBarChart.types.js.map +1 -1
  159. package/lib-amd/types/IDataPoint.d.ts +67 -0
  160. package/lib-amd/types/IDataPoint.js.map +1 -1
  161. package/lib-amd/version.js +1 -1
  162. package/lib-amd/version.js.map +1 -1
  163. package/lib-commonjs/components/AreaChart/AreaChart.types.d.ts +9 -1
  164. package/lib-commonjs/components/AreaChart/AreaChart.types.js.map +1 -1
  165. package/lib-commonjs/components/CommonComponents/CartesianChart.d.ts +4 -0
  166. package/lib-commonjs/components/CommonComponents/CartesianChart.js +4 -0
  167. package/lib-commonjs/components/CommonComponents/CartesianChart.js.map +1 -1
  168. package/lib-commonjs/components/CommonComponents/CartesianChart.types.d.ts +12 -0
  169. package/lib-commonjs/components/CommonComponents/CartesianChart.types.js.map +1 -1
  170. package/lib-commonjs/components/DonutChart/DonutChart.types.d.ts +9 -1
  171. package/lib-commonjs/components/DonutChart/DonutChart.types.js.map +1 -1
  172. package/lib-commonjs/components/GaugeChart/GaugeChart.types.d.ts +13 -2
  173. package/lib-commonjs/components/GaugeChart/GaugeChart.types.js +3 -0
  174. package/lib-commonjs/components/GaugeChart/GaugeChart.types.js.map +1 -1
  175. package/lib-commonjs/components/GroupedVerticalBarChart/GroupedVerticalBarChart.types.d.ts +9 -1
  176. package/lib-commonjs/components/GroupedVerticalBarChart/GroupedVerticalBarChart.types.js.map +1 -1
  177. package/lib-commonjs/components/HeatMapChart/HeatMapChart.types.d.ts +9 -1
  178. package/lib-commonjs/components/HeatMapChart/HeatMapChart.types.js.map +1 -1
  179. package/lib-commonjs/components/HorizontalBarChart/HorizontalBarChart.types.d.ts +13 -1
  180. package/lib-commonjs/components/HorizontalBarChart/HorizontalBarChart.types.js +3 -0
  181. package/lib-commonjs/components/HorizontalBarChart/HorizontalBarChart.types.js.map +1 -1
  182. package/lib-commonjs/components/HorizontalBarChartWithAxis/HorizontalBarChartWithAxis.types.d.ts +9 -1
  183. package/lib-commonjs/components/HorizontalBarChartWithAxis/HorizontalBarChartWithAxis.types.js.map +1 -1
  184. package/lib-commonjs/components/Legends/Legends.d.ts +1 -1
  185. package/lib-commonjs/components/Legends/Legends.js +1 -1
  186. package/lib-commonjs/components/Legends/Legends.js.map +1 -1
  187. package/lib-commonjs/components/Legends/Legends.types.d.ts +14 -8
  188. package/lib-commonjs/components/Legends/Legends.types.js.map +1 -1
  189. package/lib-commonjs/components/LineChart/LineChart.d.ts +1 -1
  190. package/lib-commonjs/components/LineChart/LineChart.js +1 -1
  191. package/lib-commonjs/components/LineChart/LineChart.js.map +1 -1
  192. package/lib-commonjs/components/LineChart/LineChart.types.d.ts +18 -1
  193. package/lib-commonjs/components/LineChart/LineChart.types.js.map +1 -1
  194. package/lib-commonjs/components/PieChart/PieChart.d.ts +1 -1
  195. package/lib-commonjs/components/PieChart/PieChart.js +1 -1
  196. package/lib-commonjs/components/PieChart/PieChart.js.map +1 -1
  197. package/lib-commonjs/components/PieChart/PieChart.types.d.ts +9 -1
  198. package/lib-commonjs/components/PieChart/PieChart.types.js.map +1 -1
  199. package/lib-commonjs/components/SankeyChart/SankeyChart.d.ts +1 -1
  200. package/lib-commonjs/components/SankeyChart/SankeyChart.js +1 -1
  201. package/lib-commonjs/components/SankeyChart/SankeyChart.js.map +1 -1
  202. package/lib-commonjs/components/SankeyChart/SankeyChart.types.d.ts +9 -1
  203. package/lib-commonjs/components/SankeyChart/SankeyChart.types.js.map +1 -1
  204. package/lib-commonjs/components/Sparkline/Sparkline.d.ts +1 -1
  205. package/lib-commonjs/components/Sparkline/Sparkline.js +1 -1
  206. package/lib-commonjs/components/Sparkline/Sparkline.js.map +1 -1
  207. package/lib-commonjs/components/Sparkline/Sparkline.types.d.ts +6 -2
  208. package/lib-commonjs/components/Sparkline/Sparkline.types.js.map +1 -1
  209. package/lib-commonjs/components/StackedBarChart/MultiStackedBarChart.d.ts +1 -1
  210. package/lib-commonjs/components/StackedBarChart/MultiStackedBarChart.js +1 -1
  211. package/lib-commonjs/components/StackedBarChart/MultiStackedBarChart.js.map +1 -1
  212. package/lib-commonjs/components/StackedBarChart/MultiStackedBarChart.types.d.ts +12 -1
  213. package/lib-commonjs/components/StackedBarChart/MultiStackedBarChart.types.js +3 -0
  214. package/lib-commonjs/components/StackedBarChart/MultiStackedBarChart.types.js.map +1 -1
  215. package/lib-commonjs/components/StackedBarChart/StackedBarChart.d.ts +1 -1
  216. package/lib-commonjs/components/StackedBarChart/StackedBarChart.js +1 -1
  217. package/lib-commonjs/components/StackedBarChart/StackedBarChart.js.map +1 -1
  218. package/lib-commonjs/components/StackedBarChart/StackedBarChart.types.d.ts +9 -1
  219. package/lib-commonjs/components/StackedBarChart/StackedBarChart.types.js.map +1 -1
  220. package/lib-commonjs/components/TreeChart/TreeChart.d.ts +1 -1
  221. package/lib-commonjs/components/TreeChart/TreeChart.js +1 -1
  222. package/lib-commonjs/components/TreeChart/TreeChart.js.map +1 -1
  223. package/lib-commonjs/components/TreeChart/TreeChart.types.d.ts +18 -1
  224. package/lib-commonjs/components/TreeChart/TreeChart.types.js +6 -0
  225. package/lib-commonjs/components/TreeChart/TreeChart.types.js.map +1 -1
  226. package/lib-commonjs/components/VerticalBarChart/VerticalBarChart.d.ts +1 -1
  227. package/lib-commonjs/components/VerticalBarChart/VerticalBarChart.js +1 -1
  228. package/lib-commonjs/components/VerticalBarChart/VerticalBarChart.js.map +1 -1
  229. package/lib-commonjs/components/VerticalBarChart/VerticalBarChart.types.d.ts +9 -1
  230. package/lib-commonjs/components/VerticalBarChart/VerticalBarChart.types.js.map +1 -1
  231. package/lib-commonjs/components/VerticalStackedBarChart/VerticalStackedBarChart.d.ts +1 -1
  232. package/lib-commonjs/components/VerticalStackedBarChart/VerticalStackedBarChart.js +1 -1
  233. package/lib-commonjs/components/VerticalStackedBarChart/VerticalStackedBarChart.js.map +1 -1
  234. package/lib-commonjs/components/VerticalStackedBarChart/VerticalStackedBarChart.types.d.ts +9 -1
  235. package/lib-commonjs/components/VerticalStackedBarChart/VerticalStackedBarChart.types.js.map +1 -1
  236. package/lib-commonjs/types/IDataPoint.d.ts +67 -0
  237. package/lib-commonjs/types/IDataPoint.js.map +1 -1
  238. package/lib-commonjs/version.js +1 -1
  239. package/lib-commonjs/version.js.map +1 -1
  240. package/package.json +1 -1
  241. package/src/components/AreaChart/AreaChart.types.ts +9 -1
  242. package/src/components/CommonComponents/CartesianChart.types.ts +12 -0
  243. package/src/components/DonutChart/DonutChart.types.ts +9 -1
  244. package/src/components/GaugeChart/GaugeChart.types.ts +13 -2
  245. package/src/components/HeatMapChart/HeatMapChart.types.ts +11 -1
  246. package/src/components/HorizontalBarChart/HorizontalBarChart.types.ts +13 -1
  247. package/src/components/HorizontalBarChartWithAxis/HorizontalBarChartWithAxis.types.ts +9 -1
  248. package/src/components/Legends/Legends.types.ts +14 -8
  249. package/src/components/LineChart/LineChart.types.ts +19 -1
  250. package/src/components/PieChart/PieChart.types.ts +10 -1
  251. package/src/components/SankeyChart/SankeyChart.types.ts +9 -1
  252. package/src/components/Sparkline/Sparkline.types.ts +6 -2
  253. package/src/components/StackedBarChart/MultiStackedBarChart.types.ts +12 -1
  254. package/src/components/StackedBarChart/StackedBarChart.types.ts +9 -1
  255. package/src/components/TreeChart/TreeChart.types.ts +20 -1
  256. package/src/components/VerticalBarChart/VerticalBarChart.types.ts +9 -1
  257. package/src/components/VerticalStackedBarChart/VerticalStackedBarChart.types.ts +9 -1
@@ -24,6 +24,10 @@ import { SVGProps } from 'react';
24
24
  */
25
25
  export declare const AreaChart: React_2.FunctionComponent<IAreaChartProps>;
26
26
 
27
+ /**
28
+ * Cartesian Chart component
29
+ * {@docCategory CartesianChart}
30
+ */
27
31
  export declare const CartesianChart: React_2.FunctionComponent<IModifiedCartesianChartProps>;
28
32
 
29
33
  /**
@@ -31,6 +35,7 @@ export declare const CartesianChart: React_2.FunctionComponent<IModifiedCartesia
31
35
  * default: show the datapoint.x value
32
36
  * fraction: show the fraction of datapoint.x/datapoint.y
33
37
  * percentage: show the percentage of (datapoint.x/datapoint.y)%
38
+ * {@docCategory HorizontalBarChart}
34
39
  */
35
40
  export declare type ChartDataMode = 'default' | 'fraction' | 'percentage';
36
41
 
@@ -112,6 +117,9 @@ export declare const DonutChart: React_2.FunctionComponent<IDonutChartProps>;
112
117
  */
113
118
  export declare const GaugeChart: React_2.FunctionComponent<IGaugeChartProps>;
114
119
 
120
+ /**
121
+ * {@docCategory GaugeChart}
122
+ */
115
123
  export declare enum GaugeValueFormat {
116
124
  Percentage = "percentage",
117
125
  Fraction = "fraction"
@@ -141,6 +149,9 @@ export declare const HeatMapChart: React_2.FunctionComponent<IHeatMapChartProps>
141
149
  */
142
150
  export declare const HorizontalBarChart: React_2.FunctionComponent<IHorizontalBarChartProps>;
143
151
 
152
+ /**
153
+ * {@docCategory HorizontalBarChart}
154
+ */
144
155
  export declare enum HorizontalBarChartVariant {
145
156
  PartToWhole = "part-to-whole",
146
157
  AbsoluteScale = "absolute-scale"
@@ -152,6 +163,9 @@ export declare enum HorizontalBarChartVariant {
152
163
  */
153
164
  export declare const HorizontalBarChartWithAxis: React_2.FunctionComponent<IHorizontalBarChartWithAxisProps>;
154
165
 
166
+ /**
167
+ * {@docCategory IChartProps}
168
+ */
155
169
  export declare interface IAccessibilityProps {
156
170
  /**
157
171
  * Accessibility aria-label
@@ -168,7 +182,7 @@ export declare interface IAccessibilityProps {
168
182
  }
169
183
 
170
184
  /**
171
- * IAreaChartProps properties for area chart.
185
+ * Area Chart properties.
172
186
  * {@docCategory AreaChart}
173
187
  */
174
188
  export declare interface IAreaChartProps extends ICartesianChartProps {
@@ -206,9 +220,17 @@ export declare interface IAreaChartProps extends ICartesianChartProps {
206
220
  optimizeLargeData?: boolean;
207
221
  }
208
222
 
223
+ /**
224
+ * Area Chart style properties
225
+ * {@docCategory AreaChart}
226
+ */
209
227
  export declare interface IAreaChartStyleProps extends ICartesianChartStyleProps {
210
228
  }
211
229
 
230
+ /**
231
+ * Area Chart styles
232
+ * {@docCategory AreaChart}
233
+ */
212
234
  export declare interface IAreaChartStyles extends ICartesianChartStyles {
213
235
  }
214
236
 
@@ -238,6 +260,10 @@ export declare interface IBasestate {
238
260
  containerHeight?: number;
239
261
  }
240
262
 
263
+ /**
264
+ * Cartesian Chart properties
265
+ * {@docCategory CartesianChart}
266
+ */
241
267
  export declare interface ICartesianChartProps {
242
268
  /**
243
269
  * Below height used for resizing of the chart
@@ -443,6 +469,10 @@ export declare interface ICartesianChartProps {
443
469
  secondaryYAxistitle?: string;
444
470
  }
445
471
 
472
+ /**
473
+ * Cartesian Chart style properties
474
+ * {@docCategory CartesianChart}
475
+ */
446
476
  export declare interface ICartesianChartStyleProps {
447
477
  /**
448
478
  * Theme (provided through customization.)
@@ -486,6 +516,10 @@ export declare interface ICartesianChartStyleProps {
486
516
  toDrawShape?: boolean;
487
517
  }
488
518
 
519
+ /**
520
+ * Cartesian Chart styles
521
+ * {@docCategory CartesianChart}
522
+ */
489
523
  export declare interface ICartesianChartStyles {
490
524
  /**
491
525
  * Style for the root element.
@@ -565,6 +599,9 @@ export declare interface ICartesianChartStyles {
565
599
  chartWrapper?: IStyle;
566
600
  }
567
601
 
602
+ /**
603
+ * {@docCategory IChartData}
604
+ */
568
605
  export declare interface IChartDataPoint {
569
606
  /**
570
607
  * Legend text for the datapoint in the chart
@@ -713,6 +750,9 @@ export declare interface IChartHoverCardStyles {
713
750
  descriptionMessage?: IStyle_2;
714
751
  }
715
752
 
753
+ /**
754
+ * {@docCategory IChartProps}
755
+ */
716
756
  export declare interface IChartProps {
717
757
  /**
718
758
  * chart title for the chart
@@ -756,11 +796,17 @@ export declare interface IChildProps {
756
796
  containerWidth?: number;
757
797
  }
758
798
 
799
+ /**
800
+ * {@docCategory LineChart}
801
+ */
759
802
  export declare interface IColorFillBarData {
760
803
  startX: number | Date;
761
804
  endX: number | Date;
762
805
  }
763
806
 
807
+ /**
808
+ * {@docCategory LineChart}
809
+ */
764
810
  export declare interface IColorFillBarsProps {
765
811
  legend: string;
766
812
  color: string;
@@ -772,12 +818,16 @@ export declare interface IColorFillBarsProps {
772
818
  /**
773
819
  * Used for custom callout data interface. As Area chart callout data will be prepared from given props.data,
774
820
  * Those required data passing to onRenderCalloutPerDataPoint and onRenderCalloutPerStack.
821
+ * {@docCategory IChartData}
775
822
  */
776
823
  export declare interface ICustomizedCalloutData {
777
824
  x: number | string | Date;
778
825
  values: ICustomizedCalloutDataPoint[];
779
826
  }
780
827
 
828
+ /**
829
+ * {@docCategory IChartData}
830
+ */
781
831
  export declare interface ICustomizedCalloutDataPoint {
782
832
  legend: string;
783
833
  y: number;
@@ -788,6 +838,9 @@ export declare interface ICustomizedCalloutDataPoint {
788
838
  };
789
839
  }
790
840
 
841
+ /**
842
+ * {@docCategory IChartData}
843
+ */
791
844
  export declare interface IDataPoint {
792
845
  /**
793
846
  * Independent value of the data point, rendered along the x-axis.
@@ -809,7 +862,7 @@ export declare interface IDonutChart {
809
862
  }
810
863
 
811
864
  /**
812
- * IDonutChartProps for Donutchart component.
865
+ * Donut Chart properties.
813
866
  * {@docCategory DonutChart}
814
867
  */
815
868
  export declare interface IDonutChartProps extends ICartesianChartProps {
@@ -853,9 +906,17 @@ export declare interface IDonutChartProps extends ICartesianChartProps {
853
906
  hideLabels?: boolean;
854
907
  }
855
908
 
909
+ /**
910
+ * Donut Chart style properties
911
+ * {@docCategory DonutChart}
912
+ */
856
913
  export declare interface IDonutChartStyleProps extends ICartesianChartStyleProps {
857
914
  }
858
915
 
916
+ /**
917
+ * Donut Chart styles
918
+ * {@docCategory DonutChart}
919
+ */
859
920
  export declare interface IDonutChartStyles {
860
921
  /**
861
922
  * Style for the root element.
@@ -877,6 +938,9 @@ declare interface IEventAnnotation {
877
938
  onRenderCard?: () => React_2.ReactNode;
878
939
  }
879
940
 
941
+ /**
942
+ * {@docCategory LineChart}
943
+ */
880
944
  export declare interface IEventsAnnotationProps {
881
945
  events: IEventAnnotation[];
882
946
  strokeColor?: string;
@@ -887,7 +951,7 @@ export declare interface IEventsAnnotationProps {
887
951
  }
888
952
 
889
953
  /**
890
- * IGaugeChartProps for Gaugechart component.
954
+ * Gauge Chart properties
891
955
  * {@docCategory GaugeChart}
892
956
  */
893
957
  export declare interface IGaugeChartProps {
@@ -968,7 +1032,7 @@ export declare interface IGaugeChartProps {
968
1032
  }
969
1033
 
970
1034
  /**
971
- * IGaugeChartSegment interface for Gaugechart.
1035
+ * Gauge Chart segment interface.
972
1036
  * {@docCategory GaugeChart}
973
1037
  */
974
1038
  export declare interface IGaugeChartSegment {
@@ -990,6 +1054,10 @@ export declare interface IGaugeChartSegment {
990
1054
  accessibilityData?: IAccessibilityProps;
991
1055
  }
992
1056
 
1057
+ /**
1058
+ * Gauge Chart style properties
1059
+ * {@docCategory GaugeChart}
1060
+ */
993
1061
  export declare interface IGaugeChartStyleProps {
994
1062
  /**
995
1063
  * Theme (provided through customization)
@@ -1021,6 +1089,10 @@ export declare interface IGaugeChartStyleProps {
1021
1089
  toDrawShape?: boolean;
1022
1090
  }
1023
1091
 
1092
+ /**
1093
+ * Gauge Chart styles
1094
+ * {@docCategory GaugeChart}
1095
+ */
1024
1096
  export declare interface IGaugeChartStyles {
1025
1097
  /**
1026
1098
  * Styles for the root element
@@ -1096,6 +1168,9 @@ export declare interface IGaugeChartStyles {
1096
1168
  shapeStyles?: IStyle;
1097
1169
  }
1098
1170
 
1171
+ /**
1172
+ * {@docCategory IChartData}
1173
+ */
1099
1174
  export declare interface IGroupedVerticalBarChartData {
1100
1175
  /**
1101
1176
  * Data for X axis label
@@ -1112,7 +1187,7 @@ export declare interface IGroupedVerticalBarChartData {
1112
1187
  }
1113
1188
 
1114
1189
  /**
1115
- * IGroupedVerticalBarChartProps for GroupedVerticalBarchart component.
1190
+ * Grouped Vertical Bar Chart properties
1116
1191
  * {@docCategory GroupedVerticalBarChart}
1117
1192
  */
1118
1193
  export declare interface IGroupedVerticalBarChartProps extends ICartesianChartProps {
@@ -1184,9 +1259,17 @@ export declare interface IGroupedVerticalBarChartProps extends ICartesianChartPr
1184
1259
  hideLabels?: boolean;
1185
1260
  }
1186
1261
 
1262
+ /**
1263
+ * Grouped Vertical Bar Chart style properties
1264
+ * {@docCategory GroupedVerticalBarChart}
1265
+ */
1187
1266
  export declare interface IGroupedVerticalBarChartStyleProps extends ICartesianChartStyleProps {
1188
1267
  }
1189
1268
 
1269
+ /**
1270
+ * Grouped Vertical Bar Chart styles
1271
+ * {@docCategory GroupedVerticalBarChart}
1272
+ */
1190
1273
  export declare interface IGroupedVerticalBarChartStyles extends ICartesianChartStyles {
1191
1274
  /**
1192
1275
  * Style to change the opacity of bars in dataviz when we hover on a single bar or legends
@@ -1198,6 +1281,9 @@ export declare interface IGroupedVerticalBarChartStyles extends ICartesianChartS
1198
1281
  barLabel: IStyle;
1199
1282
  }
1200
1283
 
1284
+ /**
1285
+ * {@docCategory IChartData}
1286
+ */
1201
1287
  export declare interface IGVBarChartSeriesPoint {
1202
1288
  /**
1203
1289
  * Text for // need to check use of this
@@ -1259,6 +1345,9 @@ export declare interface IGVSingleDataPoint {
1259
1345
  [key: string]: IGVDataPoint;
1260
1346
  }
1261
1347
 
1348
+ /**
1349
+ * {@docCategory IChartData}
1350
+ */
1262
1351
  export declare interface IHeatMapChartData {
1263
1352
  /**
1264
1353
  * name of the legend
@@ -1271,6 +1360,9 @@ export declare interface IHeatMapChartData {
1271
1360
  value: number;
1272
1361
  }
1273
1362
 
1363
+ /**
1364
+ * {@docCategory IChartData}
1365
+ */
1274
1366
  export declare interface IHeatMapChartDataPoint {
1275
1367
  x: string | Date | number;
1276
1368
  y: string | Date | number;
@@ -1298,7 +1390,7 @@ export declare interface IHeatMapChartDataPoint {
1298
1390
  }
1299
1391
 
1300
1392
  /**
1301
- * IHeatMapChartProps for HeatMapchart component.
1393
+ * Heat Map Chart properties
1302
1394
  * {@docCategory HeatMapChart}
1303
1395
  */
1304
1396
  export declare interface IHeatMapChartProps extends Pick<ICartesianChartProps, Exclude<keyof ICartesianChartProps, 'styles'>> {
@@ -1396,9 +1488,17 @@ export declare interface IHeatMapChartProps extends Pick<ICartesianChartProps, E
1396
1488
  culture?: string;
1397
1489
  }
1398
1490
 
1491
+ /**
1492
+ * Heat Map Chart style properties
1493
+ * {@docCategory HeatMapChart}
1494
+ */
1399
1495
  export declare interface IHeatMapChartStyleProps extends ICartesianChartStyleProps {
1400
1496
  }
1401
1497
 
1498
+ /**
1499
+ * Heat Map Chart styles
1500
+ * {@docCategory HeatMapChart}
1501
+ */
1402
1502
  export declare interface IHeatMapChartStyles {
1403
1503
  root?: IStyle;
1404
1504
  text?: IStyle;
@@ -1409,7 +1509,7 @@ export declare interface IHeatMapChartStyles {
1409
1509
  }
1410
1510
 
1411
1511
  /**
1412
- * IHorizontalBarChartProps for HorizontalBarchart component.
1512
+ * Horizontal Bar Chart properties
1413
1513
  * {@docCategory HorizontalBarChart}
1414
1514
  */
1415
1515
  export declare interface IHorizontalBarChartProps {
@@ -1485,6 +1585,10 @@ export declare interface IHorizontalBarChartProps {
1485
1585
  hideLabels?: boolean;
1486
1586
  }
1487
1587
 
1588
+ /**
1589
+ * Horizontal Bar Chart style properties
1590
+ * {@docCategory HorizontalBarChart}
1591
+ */
1488
1592
  export declare interface IHorizontalBarChartStyleProps {
1489
1593
  /**
1490
1594
  * Theme (provided through customization.)
@@ -1521,6 +1625,10 @@ export declare interface IHorizontalBarChartStyleProps {
1521
1625
  hideLabels?: boolean;
1522
1626
  }
1523
1627
 
1628
+ /**
1629
+ * Horizontal Bar Chart styles
1630
+ * {@docCategory HorizontalBarChart}
1631
+ */
1524
1632
  export declare interface IHorizontalBarChartStyles {
1525
1633
  /**
1526
1634
  * Styling for the root container
@@ -1572,6 +1680,9 @@ export declare interface IHorizontalBarChartStyles {
1572
1680
  chartWrapper: IStyle;
1573
1681
  }
1574
1682
 
1683
+ /**
1684
+ * {@docCategory IChartData}
1685
+ */
1575
1686
  export declare interface IHorizontalBarChartWithAxisDataPoint {
1576
1687
  /**
1577
1688
  * Dependent value of the data point, rendered along the x-axis.
@@ -1612,7 +1723,7 @@ export declare interface IHorizontalBarChartWithAxisDataPoint {
1612
1723
  }
1613
1724
 
1614
1725
  /**
1615
- * IHorizontalBarChartWithAxisProps for HorizontalBarchartWithAxis component.
1726
+ * Horizontal Bar Chart with Axis properties
1616
1727
  * {@docCategory HorizontalBarChartWithAxis}
1617
1728
  */
1618
1729
  export declare interface IHorizontalBarChartWithAxisProps extends ICartesianChartProps {
@@ -1666,6 +1777,10 @@ export declare interface IHorizontalBarChartWithAxisProps extends ICartesianChar
1666
1777
  showYAxisLables?: boolean;
1667
1778
  }
1668
1779
 
1780
+ /**
1781
+ * Horizontal Bar Chart with Axis style properties
1782
+ * {@docCategory HorizontalBarChartWithAxis}
1783
+ */
1669
1784
  export declare interface IHorizontalBarChartWithAxisStyleProps extends ICartesianChartStyleProps {
1670
1785
  /**
1671
1786
  * color of the datapoint legend
@@ -1673,6 +1788,10 @@ export declare interface IHorizontalBarChartWithAxisStyleProps extends ICartesia
1673
1788
  legendColor?: string;
1674
1789
  }
1675
1790
 
1791
+ /**
1792
+ * Horizontal Bar Chart with Axis styles
1793
+ * {@docCategory HorizontalBarChartWithAxis}
1794
+ */
1676
1795
  export declare interface IHorizontalBarChartWithAxisStyles extends ICartesianChartStyles {
1677
1796
  /**
1678
1797
  * Style for the chart label.
@@ -1715,6 +1834,9 @@ export declare interface IHorizontalBarChartWithAxisStyles extends ICartesianCha
1715
1834
  opacityChangeOnHover: IStyle;
1716
1835
  }
1717
1836
 
1837
+ /**
1838
+ * {@docCategory IChartData}
1839
+ */
1718
1840
  export declare interface IHorizontalDataPoint {
1719
1841
  /**
1720
1842
  * Independent value of the data point, rendered along the x-axis.
@@ -1730,7 +1852,7 @@ export declare interface IHorizontalDataPoint {
1730
1852
 
1731
1853
  /**
1732
1854
  * @public
1733
- * ILegendsStyles interface.
1855
+ * ILegend interface
1734
1856
  * {@docCategory Legends}
1735
1857
  */
1736
1858
  export declare interface ILegend {
@@ -1784,16 +1906,16 @@ export declare interface ILegendDataItem {
1784
1906
  legendColor: string;
1785
1907
  }
1786
1908
 
1787
- /**
1788
- * @public
1789
- * ILegendOverflowData interface.
1790
- * {@docCategory Legends}
1791
- */
1792
1909
  export declare interface ILegendOverflowData {
1793
1910
  primary: ILegend[];
1794
1911
  overflow?: ILegend[];
1795
1912
  }
1796
1913
 
1914
+ /**
1915
+ * @public
1916
+ * Legend properties
1917
+ * {@docCategory Legends}
1918
+ */
1797
1919
  export declare interface ILegendsProps {
1798
1920
  /**
1799
1921
  * Prop that takes list of legends
@@ -1855,7 +1977,7 @@ export declare interface ILegendsProps {
1855
1977
 
1856
1978
  /**
1857
1979
  * @public
1858
- * ILegendsStyles interface.
1980
+ * Legends styles
1859
1981
  * {@docCategory Legends}
1860
1982
  */
1861
1983
  export declare interface ILegendsStyles {
@@ -1901,6 +2023,11 @@ export declare interface ILegendsStyles {
1901
2023
  subComponentStyles: ILegendSubComponentStyles;
1902
2024
  }
1903
2025
 
2026
+ /**
2027
+ * @public
2028
+ * Legend style properties
2029
+ * {@docCategory Legends}
2030
+ */
1904
2031
  export declare interface ILegendStyleProps {
1905
2032
  theme?: ITheme;
1906
2033
  className?: string;
@@ -1914,13 +2041,15 @@ export declare interface ILegendStyleProps {
1914
2041
 
1915
2042
  /**
1916
2043
  * @public
1917
- * ILegendSubComponentStyles interface.
1918
2044
  * {@docCategory Legends}
1919
2045
  */
1920
2046
  export declare interface ILegendSubComponentStyles {
1921
2047
  hoverCardStyles: IStyleFunctionOrObject<IHoverCardStyleProps, IHoverCardStyles>;
1922
2048
  }
1923
2049
 
2050
+ /**
2051
+ * {@docCategory IChartData}
2052
+ */
1924
2053
  export declare interface ILineChartDataPoint {
1925
2054
  /**
1926
2055
  * Independent value of the data point, rendered along the x-axis.
@@ -1960,6 +2089,9 @@ export declare interface ILineChartDataPoint {
1960
2089
  xAxisCalloutAccessibilityData?: IAccessibilityProps;
1961
2090
  }
1962
2091
 
2092
+ /**
2093
+ * {@docCategory IChartData}
2094
+ */
1963
2095
  export declare interface ILineChartGap {
1964
2096
  /**
1965
2097
  * Starting index of the gap.
@@ -1971,6 +2103,9 @@ export declare interface ILineChartGap {
1971
2103
  endIndex: number;
1972
2104
  }
1973
2105
 
2106
+ /**
2107
+ * {@docCategory IChartProps}
2108
+ */
1974
2109
  export declare interface ILineChartLineOptions extends SVGProps<SVGPathElement> {
1975
2110
  /**
1976
2111
  * Width of the line/stroke.
@@ -2004,6 +2139,9 @@ export declare interface ILineChartLineOptions extends SVGProps<SVGPathElement>
2004
2139
  lineBorderColor?: string;
2005
2140
  }
2006
2141
 
2142
+ /**
2143
+ * {@docCategory IChartData}
2144
+ */
2007
2145
  export declare interface ILineChartPoints {
2008
2146
  /**
2009
2147
  * Legend text for the datapoint in the chart
@@ -2049,7 +2187,7 @@ export declare interface ILineChartPoints {
2049
2187
  }
2050
2188
 
2051
2189
  /**
2052
- * ILineChartProps properties for line chart.
2190
+ * Line Chart properties
2053
2191
  * {@docCategory LineChart}
2054
2192
  */
2055
2193
  export declare interface ILineChartProps extends ICartesianChartProps {
@@ -2102,12 +2240,23 @@ export declare interface ILineChartProps extends ICartesianChartProps {
2102
2240
  enablePerfOptimization?: boolean;
2103
2241
  }
2104
2242
 
2243
+ /**
2244
+ * Line Chart style properties
2245
+ * {@docCategory LineChart}
2246
+ */
2105
2247
  export declare interface ILineChartStyleProps extends ICartesianChartStyleProps {
2106
2248
  }
2107
2249
 
2250
+ /**
2251
+ * Line Chart styles
2252
+ * {@docCategory LineChart}
2253
+ */
2108
2254
  export declare interface ILineChartStyles extends ICartesianChartStyles {
2109
2255
  }
2110
2256
 
2257
+ /**
2258
+ * {@docCategory IChartData}
2259
+ */
2111
2260
  export declare interface ILineDataInVerticalBarChart {
2112
2261
  y: IVerticalBarChartDataPoint['y'];
2113
2262
  yAxisCalloutData?: string | undefined;
@@ -2122,6 +2271,9 @@ export declare interface ILineDataInVerticalBarChart {
2122
2271
  useSecondaryYScale?: boolean;
2123
2272
  }
2124
2273
 
2274
+ /**
2275
+ * {@docCategory IChartData}
2276
+ */
2125
2277
  export declare interface ILineDataInVerticalStackedBarChart {
2126
2278
  y: number;
2127
2279
  color: string;
@@ -2138,6 +2290,9 @@ export declare interface ILineDataInVerticalStackedBarChart {
2138
2290
  useSecondaryYScale?: boolean;
2139
2291
  }
2140
2292
 
2293
+ /**
2294
+ * {@docCategory IChartProps}
2295
+ */
2141
2296
  export declare interface IMargins {
2142
2297
  /**
2143
2298
  * left margin for the chart.
@@ -2295,7 +2450,7 @@ export declare interface IModifiedCartesianChartProps extends ICartesianChartPro
2295
2450
  }
2296
2451
 
2297
2452
  /**
2298
- * IMultiStackedBarChartProps for MultiStackedBarchart component.
2453
+ * Multi Stacked Bar Chart properties
2299
2454
  * {@docCategory MultiStackedBarChart}
2300
2455
  */
2301
2456
  export declare interface IMultiStackedBarChartProps {
@@ -2390,6 +2545,10 @@ export declare interface IMultiStackedBarChartProps {
2390
2545
  hideLabels?: boolean;
2391
2546
  }
2392
2547
 
2548
+ /**
2549
+ * Multi Stacked Bar Chart style properties
2550
+ * {@docCategory MultiStackedBarChart}
2551
+ */
2393
2552
  export declare interface IMultiStackedBarChartStyleProps {
2394
2553
  /**
2395
2554
  * Theme (provided through customization.)
@@ -2429,6 +2588,10 @@ export declare interface IMultiStackedBarChartStyleProps {
2429
2588
  hideLabels?: boolean;
2430
2589
  }
2431
2590
 
2591
+ /**
2592
+ * Multi Stacked Bar Chart styles
2593
+ * {@docCategory MultiStackedBarChart}
2594
+ */
2432
2595
  export declare interface IMultiStackedBarChartStyles {
2433
2596
  /**
2434
2597
  * Styling for the root container
@@ -2492,7 +2655,7 @@ export declare interface IPieChart {
2492
2655
  }
2493
2656
 
2494
2657
  /**
2495
- * IPieChartProps for Piechart component.
2658
+ * Pie Chart properties
2496
2659
  * {@docCategory PieChart}
2497
2660
  */
2498
2661
  export declare interface IPieChartProps {
@@ -2538,8 +2701,16 @@ export declare interface IPieChartProps {
2538
2701
  culture?: string;
2539
2702
  }
2540
2703
 
2704
+ /**
2705
+ * Pie Chart style properties
2706
+ * {@docCategory PieChart}
2707
+ */
2541
2708
  export declare type IPieChartStyleProps = Required<Pick<IPieChartProps, 'theme' | 'width' | 'height'>> & Pick<IPieChartProps, 'className'>;
2542
2709
 
2710
+ /**
2711
+ * Pie Chart styles
2712
+ * {@docCategory PieChart}
2713
+ */
2543
2714
  export declare interface IPieChartStyles {
2544
2715
  /**
2545
2716
  * Style for the root element.
@@ -2560,13 +2731,16 @@ export declare interface IRefArrayData {
2560
2731
  refElement?: SVGGElement;
2561
2732
  }
2562
2733
 
2734
+ /**
2735
+ * {@docCategory IChartData}
2736
+ */
2563
2737
  export declare interface ISankeyChartData {
2564
2738
  nodes: SNode[];
2565
2739
  links: SLink[];
2566
2740
  }
2567
2741
 
2568
2742
  /**
2569
- * ISankeyChartProps for Sankeychart component.
2743
+ * Sankey Chart properties
2570
2744
  * {@docCategory SankeyChart}
2571
2745
  */
2572
2746
  export declare interface ISankeyChartProps {
@@ -2616,6 +2790,10 @@ export declare interface ISankeyChartProps {
2616
2790
  borderColorsForNodes?: string[];
2617
2791
  }
2618
2792
 
2793
+ /**
2794
+ * Sankey Chart style properties
2795
+ * {@docCategory SankeyChart}
2796
+ */
2619
2797
  export declare interface ISankeyChartStyleProps {
2620
2798
  theme: ITheme;
2621
2799
  className?: string;
@@ -2624,6 +2802,10 @@ export declare interface ISankeyChartStyleProps {
2624
2802
  pathColor?: string;
2625
2803
  }
2626
2804
 
2805
+ /**
2806
+ * Sankey Chart styles
2807
+ * {@docCategory SankeyChart}
2808
+ */
2627
2809
  export declare interface ISankeyChartStyles {
2628
2810
  /**
2629
2811
  * Style for the root element.
@@ -2675,8 +2857,8 @@ declare interface ISNodeExtra {
2675
2857
  }
2676
2858
 
2677
2859
  /**
2678
- * ISparklineProps for Sparkline component.
2679
- * {@docCategory Sparkline}
2860
+ * Sparkline properties
2861
+ * {@docCategory SparklineChart}
2680
2862
  */
2681
2863
  export declare interface ISparklineProps {
2682
2864
  /**
@@ -2723,6 +2905,10 @@ export declare interface ISparklineProps {
2723
2905
  export declare interface ISparklineStyleProps extends ICartesianChartStyleProps {
2724
2906
  }
2725
2907
 
2908
+ /**
2909
+ * Sparkline styles
2910
+ * {@docCategory SparklineChart}
2911
+ */
2726
2912
  export declare interface ISparklineStyles {
2727
2913
  inlineBlock?: IStyle;
2728
2914
  valueText?: IStyle;
@@ -2732,7 +2918,7 @@ export declare interface IStackedBarChart {
2732
2918
  }
2733
2919
 
2734
2920
  /**
2735
- * IStackedBarChartProps for StackedBarchart component.
2921
+ * Stacked Bar Chart properties
2736
2922
  * {@docCategory StackedBarChart}
2737
2923
  */
2738
2924
  export declare interface IStackedBarChartProps {
@@ -2837,6 +3023,10 @@ export declare interface IStackedBarChartProps {
2837
3023
  culture?: string;
2838
3024
  }
2839
3025
 
3026
+ /**
3027
+ * Stacked Bar Chart style properties
3028
+ * {@docCategory StackedBarChart}
3029
+ */
2840
3030
  export declare interface IStackedBarChartStyleProps {
2841
3031
  /**
2842
3032
  * Theme (provided through customization.)
@@ -2892,6 +3082,10 @@ export declare interface IStackedBarChartStyleProps {
2892
3082
  showTriangle?: boolean;
2893
3083
  }
2894
3084
 
3085
+ /**
3086
+ * Stacked Bar Chart styles
3087
+ * {@docCategory StackedBarChart}
3088
+ */
2895
3089
  export declare interface IStackedBarChartStyles {
2896
3090
  /**
2897
3091
  * Style for the root element.
@@ -2951,7 +3145,6 @@ declare interface ITextboxProps {
2951
3145
  }
2952
3146
 
2953
3147
  /**
2954
- * ITreeChartDataPoint interface for Treechart component.
2955
3148
  * {@docCategory TreeChart}
2956
3149
  */
2957
3150
  export declare interface ITreeChartDataPoint {
@@ -3024,6 +3217,10 @@ export declare interface ITreeDataStructure {
3024
3217
  parentID: number;
3025
3218
  }
3026
3219
 
3220
+ /**
3221
+ * Tree Chart properties
3222
+ * {@docCategory TreeChart}
3223
+ */
3027
3224
  export declare interface ITreeProps {
3028
3225
  /**
3029
3226
  * An object of chart data points for the Tree chart
@@ -3090,6 +3287,10 @@ export declare interface ITreeState {
3090
3287
  _layoutWidth?: number;
3091
3288
  }
3092
3289
 
3290
+ /**
3291
+ * Tree Chart style properties
3292
+ * {@docCategory TreeChart}
3293
+ */
3093
3294
  export declare interface ITreeStyleProps {
3094
3295
  /**
3095
3296
  * Theme (provided through customization.)
@@ -3101,6 +3302,10 @@ export declare interface ITreeStyleProps {
3101
3302
  className?: string;
3102
3303
  }
3103
3304
 
3305
+ /**
3306
+ * Tree Chart styles
3307
+ * {@docCategory TreeChart}
3308
+ */
3104
3309
  export declare interface ITreeStyles {
3105
3310
  /**
3106
3311
  * Style for the root element.
@@ -3132,6 +3337,9 @@ export declare interface ITreeStyles {
3132
3337
  rectMetricText: IStyle;
3133
3338
  }
3134
3339
 
3340
+ /**
3341
+ * {@docCategory IChartData}
3342
+ */
3135
3343
  export declare interface IVerticalBarChartDataPoint {
3136
3344
  /**
3137
3345
  * Independent value of the data point, rendered along the x-axis.
@@ -3176,7 +3384,7 @@ export declare interface IVerticalBarChartDataPoint {
3176
3384
  }
3177
3385
 
3178
3386
  /**
3179
- * IVerticalBarChartProps for VerticalBarchart component.
3387
+ * Vertical Bar Chart properties
3180
3388
  * {@docCategory VerticalBarChart}
3181
3389
  */
3182
3390
  export declare interface IVerticalBarChartProps extends ICartesianChartProps {
@@ -3239,6 +3447,10 @@ export declare interface IVerticalBarChartProps extends ICartesianChartProps {
3239
3447
  hideLabels?: boolean;
3240
3448
  }
3241
3449
 
3450
+ /**
3451
+ * Vertical Bar Chart style properties
3452
+ * {@docCategory VerticalBarChart}
3453
+ */
3242
3454
  export declare interface IVerticalBarChartStyleProps extends ICartesianChartStyleProps {
3243
3455
  /**
3244
3456
  * color of the datapoint legend
@@ -3246,6 +3458,10 @@ export declare interface IVerticalBarChartStyleProps extends ICartesianChartStyl
3246
3458
  legendColor?: string;
3247
3459
  }
3248
3460
 
3461
+ /**
3462
+ * Vertical Bar Chart styles
3463
+ * {@docCategory VerticalBarChart}
3464
+ */
3249
3465
  export declare interface IVerticalBarChartStyles extends ICartesianChartStyles {
3250
3466
  /**
3251
3467
  * Style for the chart label.
@@ -3293,7 +3509,7 @@ export declare interface IVerticalBarChartStyles extends ICartesianChartStyles {
3293
3509
  }
3294
3510
 
3295
3511
  /**
3296
- * IVerticalStackedBarChartProps for VerticalStackedBarchart component.
3512
+ * Vertical Stacked Bar Chart properties
3297
3513
  * {@docCategory VerticalStackedBarChart}
3298
3514
  */
3299
3515
  export declare interface IVerticalStackedBarChartProps extends ICartesianChartProps {
@@ -3387,9 +3603,17 @@ export declare interface IVerticalStackedBarChartProps extends ICartesianChartPr
3387
3603
  hideLabels?: boolean;
3388
3604
  }
3389
3605
 
3606
+ /**
3607
+ * Vertical Stacked Bar Chart style properties
3608
+ * {@docCategory VerticalStackedBarChart}
3609
+ */
3390
3610
  export declare interface IVerticalStackedBarChartStyleProps extends ICartesianChartStyleProps {
3391
3611
  }
3392
3612
 
3613
+ /**
3614
+ * Vertical Stacked Bar Chart styles
3615
+ * {@docCategory VerticalStackedBarChart}
3616
+ */
3393
3617
  export declare interface IVerticalStackedBarChartStyles extends ICartesianChartStyles {
3394
3618
  /**
3395
3619
  * Style to change the opacity of bars in dataviz when we hover on a single bar or legends
@@ -3436,6 +3660,9 @@ export declare interface IVerticalStackedBarChartStyles extends ICartesianChartS
3436
3660
  yAxisText?: IStyle;
3437
3661
  }
3438
3662
 
3663
+ /**
3664
+ * {@docCategory IChartProps}
3665
+ */
3439
3666
  export declare interface IVerticalStackedChartProps {
3440
3667
  /**
3441
3668
  * data for the points in the chart
@@ -3460,6 +3687,9 @@ export declare interface IVerticalStackedChartProps {
3460
3687
  stackCallOutAccessibilityData?: IAccessibilityProps;
3461
3688
  }
3462
3689
 
3690
+ /**
3691
+ * {@docCategory IChartData}
3692
+ */
3463
3693
  export declare interface IVSChartDataPoint {
3464
3694
  /**
3465
3695
  * data the datapoint in the chart
@@ -3503,35 +3733,43 @@ export declare interface IYValueHover {
3503
3733
  }
3504
3734
 
3505
3735
  /**
3506
- * Legends component.
3736
+ * Legends component
3507
3737
  * {@docCategory Legends}
3508
3738
  */
3509
3739
  export declare const Legends: React_2.FunctionComponent<ILegendsProps>;
3510
3740
 
3511
3741
  /**
3742
+ * @public
3512
3743
  * The shape for the legend
3513
3744
  * default: show the rect legend
3514
3745
  * triangle: show the triangle legend
3746
+ * {@docCategory Legends}
3515
3747
  */
3516
3748
  export declare type LegendShape = 'default' | 'triangle' | keyof typeof Points | keyof typeof CustomPoints;
3517
3749
 
3518
3750
  /**
3519
- * Linechart component.
3751
+ * Linechart component
3520
3752
  * {@docCategory LineChart}
3521
3753
  */
3522
3754
  export declare const LineChart: React_2.FunctionComponent<ILineChartProps>;
3523
3755
 
3524
3756
  /**
3525
- * MultiStackedBarchart component.
3757
+ * MultiStackedBarchart component
3526
3758
  * {@docCategory MultiStackedBarChart}
3527
3759
  */
3528
3760
  export declare const MultiStackedBarChart: React_2.FunctionComponent<IMultiStackedBarChartProps>;
3529
3761
 
3762
+ /**
3763
+ * {@docCategory MultiStackedBarChart}
3764
+ */
3530
3765
  export declare enum MultiStackedBarChartVariant {
3531
3766
  PartToWhole = "part-to-whole",
3532
3767
  AbsoluteScale = "absolute-scale"
3533
3768
  }
3534
3769
 
3770
+ /**
3771
+ * {@docCategory TreeChart}
3772
+ */
3535
3773
  export declare enum NodesComposition {
3536
3774
  /**
3537
3775
  * NodeComposition enum val for long: number = 1
@@ -3544,7 +3782,7 @@ export declare enum NodesComposition {
3544
3782
  }
3545
3783
 
3546
3784
  /**
3547
- * Piechart component.
3785
+ * Piechart component
3548
3786
  * {@docCategory PieChart}
3549
3787
  */
3550
3788
  export declare const PieChart: React_2.FunctionComponent<IPieChartProps>;
@@ -3565,7 +3803,7 @@ declare enum Points {
3565
3803
  }
3566
3804
 
3567
3805
  /**
3568
- * Sankeychart component.
3806
+ * Sankeychart component
3569
3807
  * {@docCategory SankeyChart}
3570
3808
  */
3571
3809
  export declare const SankeyChart: React_2.FunctionComponent<ISankeyChartProps>;
@@ -3577,13 +3815,13 @@ export declare type SLink = d3Sankey.SankeyLink<ISNodeExtra, ISLinkExtra>;
3577
3815
  export declare type SNode = d3Sankey.SankeyNode<ISNodeExtra, ISLinkExtra>;
3578
3816
 
3579
3817
  /**
3580
- * Sparkline component.
3818
+ * Sparkline component
3581
3819
  * {@docCategory Sparkline}
3582
3820
  */
3583
3821
  export declare const Sparkline: React_2.FunctionComponent<ISparklineProps>;
3584
3822
 
3585
3823
  /**
3586
- * StackedBarchart component.
3824
+ * StackedBarchart component
3587
3825
  * {@docCategory StackedBarChart}
3588
3826
  */
3589
3827
  export declare const StackedBarChart: React_2.FunctionComponent<IStackedBarChartProps>;
@@ -3591,11 +3829,14 @@ export declare const StackedBarChart: React_2.FunctionComponent<IStackedBarChart
3591
3829
  export declare const Textbox: React_2.FunctionComponent<ITextboxProps>;
3592
3830
 
3593
3831
  /**
3594
- * Treechart component.
3832
+ * Treechart component
3595
3833
  * {@docCategory TreeChart}
3596
3834
  */
3597
3835
  export declare const TreeChart: React_2.FunctionComponent<ITreeProps>;
3598
3836
 
3837
+ /**
3838
+ * {@docCategory TreeChart}
3839
+ */
3599
3840
  export declare enum TreeTraverse {
3600
3841
  /**
3601
3842
  * TreeTraverse enum val for preOrder: number = 1
@@ -3608,13 +3849,13 @@ export declare enum TreeTraverse {
3608
3849
  }
3609
3850
 
3610
3851
  /**
3611
- * VerticalBarchart component.
3852
+ * VerticalBarchart component
3612
3853
  * {@docCategory VerticalBarChart}
3613
3854
  */
3614
3855
  export declare const VerticalBarChart: React_2.FunctionComponent<IVerticalBarChartProps>;
3615
3856
 
3616
3857
  /**
3617
- * VerticalStackedBarchart component.
3858
+ * VerticalStackedBarchart component
3618
3859
  * {@docCategory VerticalStackedBarChart}
3619
3860
  */
3620
3861
  export declare const VerticalStackedBarChart: React_2.FunctionComponent<IVerticalStackedBarChartProps>;