@fluentui/react-charting 5.18.8 → 5.18.10

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 (263) hide show
  1. package/CHANGELOG.json +55 -1
  2. package/CHANGELOG.md +24 -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.base.js +2 -1
  12. package/lib/components/CommonComponents/CartesianChart.base.js.map +1 -1
  13. package/lib/components/CommonComponents/CartesianChart.d.ts +4 -0
  14. package/lib/components/CommonComponents/CartesianChart.js +4 -0
  15. package/lib/components/CommonComponents/CartesianChart.js.map +1 -1
  16. package/lib/components/CommonComponents/CartesianChart.types.d.ts +12 -0
  17. package/lib/components/CommonComponents/CartesianChart.types.js.map +1 -1
  18. package/lib/components/DonutChart/DonutChart.types.d.ts +9 -1
  19. package/lib/components/DonutChart/DonutChart.types.js.map +1 -1
  20. package/lib/components/GaugeChart/GaugeChart.types.d.ts +13 -2
  21. package/lib/components/GaugeChart/GaugeChart.types.js +3 -0
  22. package/lib/components/GaugeChart/GaugeChart.types.js.map +1 -1
  23. package/lib/components/GroupedVerticalBarChart/GroupedVerticalBarChart.types.d.ts +9 -1
  24. package/lib/components/GroupedVerticalBarChart/GroupedVerticalBarChart.types.js.map +1 -1
  25. package/lib/components/HeatMapChart/HeatMapChart.types.d.ts +9 -1
  26. package/lib/components/HeatMapChart/HeatMapChart.types.js.map +1 -1
  27. package/lib/components/HorizontalBarChart/HorizontalBarChart.types.d.ts +13 -1
  28. package/lib/components/HorizontalBarChart/HorizontalBarChart.types.js +3 -0
  29. package/lib/components/HorizontalBarChart/HorizontalBarChart.types.js.map +1 -1
  30. package/lib/components/HorizontalBarChartWithAxis/HorizontalBarChartWithAxis.types.d.ts +9 -1
  31. package/lib/components/HorizontalBarChartWithAxis/HorizontalBarChartWithAxis.types.js.map +1 -1
  32. package/lib/components/Legends/Legends.d.ts +1 -1
  33. package/lib/components/Legends/Legends.js +1 -1
  34. package/lib/components/Legends/Legends.js.map +1 -1
  35. package/lib/components/Legends/Legends.types.d.ts +14 -8
  36. package/lib/components/Legends/Legends.types.js.map +1 -1
  37. package/lib/components/LineChart/LineChart.d.ts +1 -1
  38. package/lib/components/LineChart/LineChart.js +1 -1
  39. package/lib/components/LineChart/LineChart.js.map +1 -1
  40. package/lib/components/LineChart/LineChart.types.d.ts +18 -1
  41. package/lib/components/LineChart/LineChart.types.js.map +1 -1
  42. package/lib/components/PieChart/PieChart.d.ts +1 -1
  43. package/lib/components/PieChart/PieChart.js +1 -1
  44. package/lib/components/PieChart/PieChart.js.map +1 -1
  45. package/lib/components/PieChart/PieChart.types.d.ts +9 -1
  46. package/lib/components/PieChart/PieChart.types.js.map +1 -1
  47. package/lib/components/SankeyChart/SankeyChart.d.ts +1 -1
  48. package/lib/components/SankeyChart/SankeyChart.js +1 -1
  49. package/lib/components/SankeyChart/SankeyChart.js.map +1 -1
  50. package/lib/components/SankeyChart/SankeyChart.types.d.ts +9 -1
  51. package/lib/components/SankeyChart/SankeyChart.types.js.map +1 -1
  52. package/lib/components/Sparkline/Sparkline.d.ts +1 -1
  53. package/lib/components/Sparkline/Sparkline.js +1 -1
  54. package/lib/components/Sparkline/Sparkline.js.map +1 -1
  55. package/lib/components/Sparkline/Sparkline.types.d.ts +6 -2
  56. package/lib/components/Sparkline/Sparkline.types.js.map +1 -1
  57. package/lib/components/StackedBarChart/MultiStackedBarChart.d.ts +1 -1
  58. package/lib/components/StackedBarChart/MultiStackedBarChart.js +1 -1
  59. package/lib/components/StackedBarChart/MultiStackedBarChart.js.map +1 -1
  60. package/lib/components/StackedBarChart/MultiStackedBarChart.types.d.ts +12 -1
  61. package/lib/components/StackedBarChart/MultiStackedBarChart.types.js +3 -0
  62. package/lib/components/StackedBarChart/MultiStackedBarChart.types.js.map +1 -1
  63. package/lib/components/StackedBarChart/StackedBarChart.d.ts +1 -1
  64. package/lib/components/StackedBarChart/StackedBarChart.js +1 -1
  65. package/lib/components/StackedBarChart/StackedBarChart.js.map +1 -1
  66. package/lib/components/StackedBarChart/StackedBarChart.types.d.ts +9 -1
  67. package/lib/components/StackedBarChart/StackedBarChart.types.js.map +1 -1
  68. package/lib/components/TreeChart/TreeChart.d.ts +1 -1
  69. package/lib/components/TreeChart/TreeChart.js +1 -1
  70. package/lib/components/TreeChart/TreeChart.js.map +1 -1
  71. package/lib/components/TreeChart/TreeChart.types.d.ts +18 -1
  72. package/lib/components/TreeChart/TreeChart.types.js +6 -0
  73. package/lib/components/TreeChart/TreeChart.types.js.map +1 -1
  74. package/lib/components/VerticalBarChart/VerticalBarChart.d.ts +1 -1
  75. package/lib/components/VerticalBarChart/VerticalBarChart.js +1 -1
  76. package/lib/components/VerticalBarChart/VerticalBarChart.js.map +1 -1
  77. package/lib/components/VerticalBarChart/VerticalBarChart.types.d.ts +9 -1
  78. package/lib/components/VerticalBarChart/VerticalBarChart.types.js.map +1 -1
  79. package/lib/components/VerticalStackedBarChart/VerticalStackedBarChart.d.ts +1 -1
  80. package/lib/components/VerticalStackedBarChart/VerticalStackedBarChart.js +1 -1
  81. package/lib/components/VerticalStackedBarChart/VerticalStackedBarChart.js.map +1 -1
  82. package/lib/components/VerticalStackedBarChart/VerticalStackedBarChart.types.d.ts +9 -1
  83. package/lib/components/VerticalStackedBarChart/VerticalStackedBarChart.types.js.map +1 -1
  84. package/lib/types/IDataPoint.d.ts +67 -0
  85. package/lib/types/IDataPoint.js.map +1 -1
  86. package/lib/version.js +1 -1
  87. package/lib/version.js.map +1 -1
  88. package/lib-amd/components/AreaChart/AreaChart.types.d.ts +9 -1
  89. package/lib-amd/components/AreaChart/AreaChart.types.js.map +1 -1
  90. package/lib-amd/components/CommonComponents/CartesianChart.base.js +2 -1
  91. package/lib-amd/components/CommonComponents/CartesianChart.base.js.map +1 -1
  92. package/lib-amd/components/CommonComponents/CartesianChart.d.ts +4 -0
  93. package/lib-amd/components/CommonComponents/CartesianChart.js +4 -0
  94. package/lib-amd/components/CommonComponents/CartesianChart.js.map +1 -1
  95. package/lib-amd/components/CommonComponents/CartesianChart.types.d.ts +12 -0
  96. package/lib-amd/components/CommonComponents/CartesianChart.types.js.map +1 -1
  97. package/lib-amd/components/DonutChart/DonutChart.types.d.ts +9 -1
  98. package/lib-amd/components/DonutChart/DonutChart.types.js.map +1 -1
  99. package/lib-amd/components/GaugeChart/GaugeChart.types.d.ts +13 -2
  100. package/lib-amd/components/GaugeChart/GaugeChart.types.js +3 -0
  101. package/lib-amd/components/GaugeChart/GaugeChart.types.js.map +1 -1
  102. package/lib-amd/components/GroupedVerticalBarChart/GroupedVerticalBarChart.types.d.ts +9 -1
  103. package/lib-amd/components/GroupedVerticalBarChart/GroupedVerticalBarChart.types.js.map +1 -1
  104. package/lib-amd/components/HeatMapChart/HeatMapChart.types.d.ts +9 -1
  105. package/lib-amd/components/HeatMapChart/HeatMapChart.types.js.map +1 -1
  106. package/lib-amd/components/HorizontalBarChart/HorizontalBarChart.types.d.ts +13 -1
  107. package/lib-amd/components/HorizontalBarChart/HorizontalBarChart.types.js +3 -0
  108. package/lib-amd/components/HorizontalBarChart/HorizontalBarChart.types.js.map +1 -1
  109. package/lib-amd/components/HorizontalBarChartWithAxis/HorizontalBarChartWithAxis.types.d.ts +9 -1
  110. package/lib-amd/components/HorizontalBarChartWithAxis/HorizontalBarChartWithAxis.types.js.map +1 -1
  111. package/lib-amd/components/Legends/Legends.d.ts +1 -1
  112. package/lib-amd/components/Legends/Legends.js +1 -1
  113. package/lib-amd/components/Legends/Legends.js.map +1 -1
  114. package/lib-amd/components/Legends/Legends.types.d.ts +14 -8
  115. package/lib-amd/components/Legends/Legends.types.js.map +1 -1
  116. package/lib-amd/components/LineChart/LineChart.d.ts +1 -1
  117. package/lib-amd/components/LineChart/LineChart.js +1 -1
  118. package/lib-amd/components/LineChart/LineChart.js.map +1 -1
  119. package/lib-amd/components/LineChart/LineChart.types.d.ts +18 -1
  120. package/lib-amd/components/LineChart/LineChart.types.js.map +1 -1
  121. package/lib-amd/components/PieChart/PieChart.d.ts +1 -1
  122. package/lib-amd/components/PieChart/PieChart.js +1 -1
  123. package/lib-amd/components/PieChart/PieChart.js.map +1 -1
  124. package/lib-amd/components/PieChart/PieChart.types.d.ts +9 -1
  125. package/lib-amd/components/PieChart/PieChart.types.js.map +1 -1
  126. package/lib-amd/components/SankeyChart/SankeyChart.d.ts +1 -1
  127. package/lib-amd/components/SankeyChart/SankeyChart.js +1 -1
  128. package/lib-amd/components/SankeyChart/SankeyChart.js.map +1 -1
  129. package/lib-amd/components/SankeyChart/SankeyChart.types.d.ts +9 -1
  130. package/lib-amd/components/SankeyChart/SankeyChart.types.js.map +1 -1
  131. package/lib-amd/components/Sparkline/Sparkline.d.ts +1 -1
  132. package/lib-amd/components/Sparkline/Sparkline.js +1 -1
  133. package/lib-amd/components/Sparkline/Sparkline.js.map +1 -1
  134. package/lib-amd/components/Sparkline/Sparkline.types.d.ts +6 -2
  135. package/lib-amd/components/Sparkline/Sparkline.types.js.map +1 -1
  136. package/lib-amd/components/StackedBarChart/MultiStackedBarChart.d.ts +1 -1
  137. package/lib-amd/components/StackedBarChart/MultiStackedBarChart.js +1 -1
  138. package/lib-amd/components/StackedBarChart/MultiStackedBarChart.js.map +1 -1
  139. package/lib-amd/components/StackedBarChart/MultiStackedBarChart.types.d.ts +12 -1
  140. package/lib-amd/components/StackedBarChart/MultiStackedBarChart.types.js +3 -0
  141. package/lib-amd/components/StackedBarChart/MultiStackedBarChart.types.js.map +1 -1
  142. package/lib-amd/components/StackedBarChart/StackedBarChart.d.ts +1 -1
  143. package/lib-amd/components/StackedBarChart/StackedBarChart.js +1 -1
  144. package/lib-amd/components/StackedBarChart/StackedBarChart.js.map +1 -1
  145. package/lib-amd/components/StackedBarChart/StackedBarChart.types.d.ts +9 -1
  146. package/lib-amd/components/StackedBarChart/StackedBarChart.types.js.map +1 -1
  147. package/lib-amd/components/TreeChart/TreeChart.d.ts +1 -1
  148. package/lib-amd/components/TreeChart/TreeChart.js +1 -1
  149. package/lib-amd/components/TreeChart/TreeChart.js.map +1 -1
  150. package/lib-amd/components/TreeChart/TreeChart.types.d.ts +18 -1
  151. package/lib-amd/components/TreeChart/TreeChart.types.js +6 -0
  152. package/lib-amd/components/TreeChart/TreeChart.types.js.map +1 -1
  153. package/lib-amd/components/VerticalBarChart/VerticalBarChart.d.ts +1 -1
  154. package/lib-amd/components/VerticalBarChart/VerticalBarChart.js +1 -1
  155. package/lib-amd/components/VerticalBarChart/VerticalBarChart.js.map +1 -1
  156. package/lib-amd/components/VerticalBarChart/VerticalBarChart.types.d.ts +9 -1
  157. package/lib-amd/components/VerticalBarChart/VerticalBarChart.types.js.map +1 -1
  158. package/lib-amd/components/VerticalStackedBarChart/VerticalStackedBarChart.d.ts +1 -1
  159. package/lib-amd/components/VerticalStackedBarChart/VerticalStackedBarChart.js +1 -1
  160. package/lib-amd/components/VerticalStackedBarChart/VerticalStackedBarChart.js.map +1 -1
  161. package/lib-amd/components/VerticalStackedBarChart/VerticalStackedBarChart.types.d.ts +9 -1
  162. package/lib-amd/components/VerticalStackedBarChart/VerticalStackedBarChart.types.js.map +1 -1
  163. package/lib-amd/types/IDataPoint.d.ts +67 -0
  164. package/lib-amd/types/IDataPoint.js.map +1 -1
  165. package/lib-amd/version.js +1 -1
  166. package/lib-amd/version.js.map +1 -1
  167. package/lib-commonjs/components/AreaChart/AreaChart.types.d.ts +9 -1
  168. package/lib-commonjs/components/AreaChart/AreaChart.types.js.map +1 -1
  169. package/lib-commonjs/components/CommonComponents/CartesianChart.base.js +2 -1
  170. package/lib-commonjs/components/CommonComponents/CartesianChart.base.js.map +1 -1
  171. package/lib-commonjs/components/CommonComponents/CartesianChart.d.ts +4 -0
  172. package/lib-commonjs/components/CommonComponents/CartesianChart.js +4 -0
  173. package/lib-commonjs/components/CommonComponents/CartesianChart.js.map +1 -1
  174. package/lib-commonjs/components/CommonComponents/CartesianChart.types.d.ts +12 -0
  175. package/lib-commonjs/components/CommonComponents/CartesianChart.types.js.map +1 -1
  176. package/lib-commonjs/components/DonutChart/DonutChart.types.d.ts +9 -1
  177. package/lib-commonjs/components/DonutChart/DonutChart.types.js.map +1 -1
  178. package/lib-commonjs/components/GaugeChart/GaugeChart.types.d.ts +13 -2
  179. package/lib-commonjs/components/GaugeChart/GaugeChart.types.js +3 -0
  180. package/lib-commonjs/components/GaugeChart/GaugeChart.types.js.map +1 -1
  181. package/lib-commonjs/components/GroupedVerticalBarChart/GroupedVerticalBarChart.types.d.ts +9 -1
  182. package/lib-commonjs/components/GroupedVerticalBarChart/GroupedVerticalBarChart.types.js.map +1 -1
  183. package/lib-commonjs/components/HeatMapChart/HeatMapChart.types.d.ts +9 -1
  184. package/lib-commonjs/components/HeatMapChart/HeatMapChart.types.js.map +1 -1
  185. package/lib-commonjs/components/HorizontalBarChart/HorizontalBarChart.types.d.ts +13 -1
  186. package/lib-commonjs/components/HorizontalBarChart/HorizontalBarChart.types.js +3 -0
  187. package/lib-commonjs/components/HorizontalBarChart/HorizontalBarChart.types.js.map +1 -1
  188. package/lib-commonjs/components/HorizontalBarChartWithAxis/HorizontalBarChartWithAxis.types.d.ts +9 -1
  189. package/lib-commonjs/components/HorizontalBarChartWithAxis/HorizontalBarChartWithAxis.types.js.map +1 -1
  190. package/lib-commonjs/components/Legends/Legends.d.ts +1 -1
  191. package/lib-commonjs/components/Legends/Legends.js +1 -1
  192. package/lib-commonjs/components/Legends/Legends.js.map +1 -1
  193. package/lib-commonjs/components/Legends/Legends.types.d.ts +14 -8
  194. package/lib-commonjs/components/Legends/Legends.types.js.map +1 -1
  195. package/lib-commonjs/components/LineChart/LineChart.d.ts +1 -1
  196. package/lib-commonjs/components/LineChart/LineChart.js +1 -1
  197. package/lib-commonjs/components/LineChart/LineChart.js.map +1 -1
  198. package/lib-commonjs/components/LineChart/LineChart.types.d.ts +18 -1
  199. package/lib-commonjs/components/LineChart/LineChart.types.js.map +1 -1
  200. package/lib-commonjs/components/PieChart/PieChart.d.ts +1 -1
  201. package/lib-commonjs/components/PieChart/PieChart.js +1 -1
  202. package/lib-commonjs/components/PieChart/PieChart.js.map +1 -1
  203. package/lib-commonjs/components/PieChart/PieChart.types.d.ts +9 -1
  204. package/lib-commonjs/components/PieChart/PieChart.types.js.map +1 -1
  205. package/lib-commonjs/components/SankeyChart/SankeyChart.d.ts +1 -1
  206. package/lib-commonjs/components/SankeyChart/SankeyChart.js +1 -1
  207. package/lib-commonjs/components/SankeyChart/SankeyChart.js.map +1 -1
  208. package/lib-commonjs/components/SankeyChart/SankeyChart.types.d.ts +9 -1
  209. package/lib-commonjs/components/SankeyChart/SankeyChart.types.js.map +1 -1
  210. package/lib-commonjs/components/Sparkline/Sparkline.d.ts +1 -1
  211. package/lib-commonjs/components/Sparkline/Sparkline.js +1 -1
  212. package/lib-commonjs/components/Sparkline/Sparkline.js.map +1 -1
  213. package/lib-commonjs/components/Sparkline/Sparkline.types.d.ts +6 -2
  214. package/lib-commonjs/components/Sparkline/Sparkline.types.js.map +1 -1
  215. package/lib-commonjs/components/StackedBarChart/MultiStackedBarChart.d.ts +1 -1
  216. package/lib-commonjs/components/StackedBarChart/MultiStackedBarChart.js +1 -1
  217. package/lib-commonjs/components/StackedBarChart/MultiStackedBarChart.js.map +1 -1
  218. package/lib-commonjs/components/StackedBarChart/MultiStackedBarChart.types.d.ts +12 -1
  219. package/lib-commonjs/components/StackedBarChart/MultiStackedBarChart.types.js +3 -0
  220. package/lib-commonjs/components/StackedBarChart/MultiStackedBarChart.types.js.map +1 -1
  221. package/lib-commonjs/components/StackedBarChart/StackedBarChart.d.ts +1 -1
  222. package/lib-commonjs/components/StackedBarChart/StackedBarChart.js +1 -1
  223. package/lib-commonjs/components/StackedBarChart/StackedBarChart.js.map +1 -1
  224. package/lib-commonjs/components/StackedBarChart/StackedBarChart.types.d.ts +9 -1
  225. package/lib-commonjs/components/StackedBarChart/StackedBarChart.types.js.map +1 -1
  226. package/lib-commonjs/components/TreeChart/TreeChart.d.ts +1 -1
  227. package/lib-commonjs/components/TreeChart/TreeChart.js +1 -1
  228. package/lib-commonjs/components/TreeChart/TreeChart.js.map +1 -1
  229. package/lib-commonjs/components/TreeChart/TreeChart.types.d.ts +18 -1
  230. package/lib-commonjs/components/TreeChart/TreeChart.types.js +6 -0
  231. package/lib-commonjs/components/TreeChart/TreeChart.types.js.map +1 -1
  232. package/lib-commonjs/components/VerticalBarChart/VerticalBarChart.d.ts +1 -1
  233. package/lib-commonjs/components/VerticalBarChart/VerticalBarChart.js +1 -1
  234. package/lib-commonjs/components/VerticalBarChart/VerticalBarChart.js.map +1 -1
  235. package/lib-commonjs/components/VerticalBarChart/VerticalBarChart.types.d.ts +9 -1
  236. package/lib-commonjs/components/VerticalBarChart/VerticalBarChart.types.js.map +1 -1
  237. package/lib-commonjs/components/VerticalStackedBarChart/VerticalStackedBarChart.d.ts +1 -1
  238. package/lib-commonjs/components/VerticalStackedBarChart/VerticalStackedBarChart.js +1 -1
  239. package/lib-commonjs/components/VerticalStackedBarChart/VerticalStackedBarChart.js.map +1 -1
  240. package/lib-commonjs/components/VerticalStackedBarChart/VerticalStackedBarChart.types.d.ts +9 -1
  241. package/lib-commonjs/components/VerticalStackedBarChart/VerticalStackedBarChart.types.js.map +1 -1
  242. package/lib-commonjs/types/IDataPoint.d.ts +67 -0
  243. package/lib-commonjs/types/IDataPoint.js.map +1 -1
  244. package/lib-commonjs/version.js +1 -1
  245. package/lib-commonjs/version.js.map +1 -1
  246. package/package.json +5 -5
  247. package/src/components/AreaChart/AreaChart.types.ts +9 -1
  248. package/src/components/CommonComponents/CartesianChart.types.ts +12 -0
  249. package/src/components/DonutChart/DonutChart.types.ts +9 -1
  250. package/src/components/GaugeChart/GaugeChart.types.ts +13 -2
  251. package/src/components/HeatMapChart/HeatMapChart.types.ts +11 -1
  252. package/src/components/HorizontalBarChart/HorizontalBarChart.types.ts +13 -1
  253. package/src/components/HorizontalBarChartWithAxis/HorizontalBarChartWithAxis.types.ts +9 -1
  254. package/src/components/Legends/Legends.types.ts +14 -8
  255. package/src/components/LineChart/LineChart.types.ts +19 -1
  256. package/src/components/PieChart/PieChart.types.ts +10 -1
  257. package/src/components/SankeyChart/SankeyChart.types.ts +9 -1
  258. package/src/components/Sparkline/Sparkline.types.ts +6 -2
  259. package/src/components/StackedBarChart/MultiStackedBarChart.types.ts +12 -1
  260. package/src/components/StackedBarChart/StackedBarChart.types.ts +9 -1
  261. package/src/components/TreeChart/TreeChart.types.ts +20 -1
  262. package/src/components/VerticalBarChart/VerticalBarChart.types.ts +9 -1
  263. package/src/components/VerticalStackedBarChart/VerticalStackedBarChart.types.ts +9 -1
@@ -30,6 +30,9 @@ export interface IRefArrayData {
30
30
  index?: string;
31
31
  refElement?: SVGGElement;
32
32
  }
33
+ /**
34
+ * {@docCategory IChartProps}
35
+ */
33
36
  export interface IMargins {
34
37
  /**
35
38
  * left margin for the chart.
@@ -48,6 +51,9 @@ export interface IMargins {
48
51
  */
49
52
  bottom?: number;
50
53
  }
54
+ /**
55
+ * {@docCategory IChartData}
56
+ */
51
57
  export interface IDataPoint {
52
58
  /**
53
59
  * Independent value of the data point, rendered along the x-axis.
@@ -64,6 +70,9 @@ export interface IDataPoint {
64
70
  */
65
71
  onClick?: VoidFunction;
66
72
  }
73
+ /**
74
+ * {@docCategory IChartData}
75
+ */
67
76
  export interface IHorizontalDataPoint {
68
77
  /**
69
78
  * Independent value of the data point, rendered along the x-axis.
@@ -76,6 +85,9 @@ export interface IHorizontalDataPoint {
76
85
  */
77
86
  y: number;
78
87
  }
88
+ /**
89
+ * {@docCategory IChartData}
90
+ */
79
91
  export interface IChartDataPoint {
80
92
  /**
81
93
  * Legend text for the datapoint in the chart
@@ -116,6 +128,9 @@ export interface IChartDataPoint {
116
128
  */
117
129
  callOutAccessibilityData?: IAccessibilityProps;
118
130
  }
131
+ /**
132
+ * {@docCategory IChartData}
133
+ */
119
134
  export interface IVerticalBarChartDataPoint {
120
135
  /**
121
136
  * Independent value of the data point, rendered along the x-axis.
@@ -158,6 +173,9 @@ export interface IVerticalBarChartDataPoint {
158
173
  */
159
174
  callOutAccessibilityData?: IAccessibilityProps;
160
175
  }
176
+ /**
177
+ * {@docCategory IChartData}
178
+ */
161
179
  export interface IHorizontalBarChartWithAxisDataPoint {
162
180
  /**
163
181
  * Dependent value of the data point, rendered along the x-axis.
@@ -196,6 +214,9 @@ export interface IHorizontalBarChartWithAxisDataPoint {
196
214
  */
197
215
  callOutAccessibilityData?: IAccessibilityProps;
198
216
  }
217
+ /**
218
+ * {@docCategory IChartData}
219
+ */
199
220
  export interface ILineDataInVerticalBarChart {
200
221
  y: IVerticalBarChartDataPoint['y'];
201
222
  yAxisCalloutData?: string | undefined;
@@ -209,6 +230,9 @@ export interface ILineDataInVerticalBarChart {
209
230
  */
210
231
  useSecondaryYScale?: boolean;
211
232
  }
233
+ /**
234
+ * {@docCategory IChartData}
235
+ */
212
236
  export interface ILineChartDataPoint {
213
237
  /**
214
238
  * Independent value of the data point, rendered along the x-axis.
@@ -247,6 +271,9 @@ export interface ILineChartDataPoint {
247
271
  */
248
272
  xAxisCalloutAccessibilityData?: IAccessibilityProps;
249
273
  }
274
+ /**
275
+ * {@docCategory IChartData}
276
+ */
250
277
  export interface ILineChartGap {
251
278
  /**
252
279
  * Starting index of the gap.
@@ -257,6 +284,9 @@ export interface ILineChartGap {
257
284
  */
258
285
  endIndex: number;
259
286
  }
287
+ /**
288
+ * {@docCategory IChartProps}
289
+ */
260
290
  export interface ILineChartLineOptions extends SVGProps<SVGPathElement> {
261
291
  /**
262
292
  * Width of the line/stroke.
@@ -289,6 +319,9 @@ export interface ILineChartLineOptions extends SVGProps<SVGPathElement> {
289
319
  */
290
320
  lineBorderColor?: string;
291
321
  }
322
+ /**
323
+ * {@docCategory IChartData}
324
+ */
292
325
  export interface ILineChartPoints {
293
326
  /**
294
327
  * Legend text for the datapoint in the chart
@@ -332,6 +365,9 @@ export interface ILineChartPoints {
332
365
  */
333
366
  onLineClick?: () => void;
334
367
  }
368
+ /**
369
+ * {@docCategory IChartProps}
370
+ */
335
371
  export interface IChartProps {
336
372
  /**
337
373
  * chart title for the chart
@@ -366,6 +402,9 @@ export interface IChartProps {
366
402
  */
367
403
  pointLineOptions?: SVGProps<SVGLineElement>;
368
404
  }
405
+ /**
406
+ * {@docCategory IChartData}
407
+ */
369
408
  export interface ISankeyChartData {
370
409
  nodes: SNode[];
371
410
  links: SLink[];
@@ -386,6 +425,9 @@ interface ISLinkExtra {
386
425
  }
387
426
  export declare type SNode = d3Sankey.SankeyNode<ISNodeExtra, ISLinkExtra>;
388
427
  export declare type SLink = d3Sankey.SankeyLink<ISNodeExtra, ISLinkExtra>;
428
+ /**
429
+ * {@docCategory IChartProps}
430
+ */
389
431
  export interface IAccessibilityProps {
390
432
  /**
391
433
  * Accessibility aria-label
@@ -400,6 +442,9 @@ export interface IAccessibilityProps {
400
442
  */
401
443
  ariaDescribedBy?: string;
402
444
  }
445
+ /**
446
+ * {@docCategory IChartData}
447
+ */
403
448
  export interface IVSChartDataPoint {
404
449
  /**
405
450
  * data the datapoint in the chart
@@ -428,6 +473,9 @@ export interface IVSChartDataPoint {
428
473
  */
429
474
  callOutAccessibilityData?: IAccessibilityProps;
430
475
  }
476
+ /**
477
+ * {@docCategory IChartProps}
478
+ */
431
479
  export interface IVerticalStackedChartProps {
432
480
  /**
433
481
  * data for the points in the chart
@@ -451,6 +499,9 @@ export interface IVerticalStackedChartProps {
451
499
  */
452
500
  stackCallOutAccessibilityData?: IAccessibilityProps;
453
501
  }
502
+ /**
503
+ * {@docCategory IChartData}
504
+ */
454
505
  export interface ILineDataInVerticalStackedBarChart {
455
506
  y: number;
456
507
  color: string;
@@ -466,6 +517,9 @@ export interface ILineDataInVerticalStackedBarChart {
466
517
  */
467
518
  useSecondaryYScale?: boolean;
468
519
  }
520
+ /**
521
+ * {@docCategory IChartData}
522
+ */
469
523
  export interface IGVBarChartSeriesPoint {
470
524
  /**
471
525
  * Text for // need to check use of this
@@ -502,6 +556,9 @@ export interface IGVBarChartSeriesPoint {
502
556
  */
503
557
  callOutAccessibilityData?: IAccessibilityProps;
504
558
  }
559
+ /**
560
+ * {@docCategory IChartData}
561
+ */
505
562
  export interface IGroupedVerticalBarChartData {
506
563
  /**
507
564
  * Data for X axis label
@@ -537,6 +594,9 @@ export interface IGVForBarChart {
537
594
  */
538
595
  [key: string]: IGVBarChartSeriesPoint;
539
596
  }
597
+ /**
598
+ * {@docCategory IChartData}
599
+ */
540
600
  export interface IHeatMapChartDataPoint {
541
601
  x: string | Date | number;
542
602
  y: string | Date | number;
@@ -562,6 +622,9 @@ export interface IHeatMapChartDataPoint {
562
622
  */
563
623
  callOutAccessibilityData?: IAccessibilityProps;
564
624
  }
625
+ /**
626
+ * {@docCategory IChartData}
627
+ */
565
628
  export interface IHeatMapChartData {
566
629
  /**
567
630
  * name of the legend
@@ -573,6 +636,9 @@ export interface IHeatMapChartData {
573
636
  */
574
637
  value: number;
575
638
  }
639
+ /**
640
+ * {@docCategory IChartData}
641
+ */
576
642
  export interface ICustomizedCalloutDataPoint {
577
643
  legend: string;
578
644
  y: number;
@@ -585,6 +651,7 @@ export interface ICustomizedCalloutDataPoint {
585
651
  /**
586
652
  * Used for custom callout data interface. As Area chart callout data will be prepared from given props.data,
587
653
  * Those required data passing to onRenderCalloutPerDataPoint and onRenderCalloutPerStack.
654
+ * {@docCategory IChartData}
588
655
  */
589
656
  export interface ICustomizedCalloutData {
590
657
  x: number | string | Date;
@@ -1 +1 @@
1
- {"version":3,"file":"IDataPoint.js","sourceRoot":"../src/","sources":["types/IDataPoint.ts"],"names":[],"mappings":"","sourcesContent":["import { SVGProps } from 'react';\nimport { LegendShape } from '../components/Legends/Legends.types';\nimport * as d3Sankey from 'd3-sankey';\nexport interface IBasestate {\n _width?: number;\n _height?: number;\n activeLegend?: string;\n color?: string;\n dataForHoverCard?: number;\n isCalloutVisible: boolean;\n isLegendSelected?: boolean;\n isLegendHovered?: boolean;\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n refSelected?: any;\n YValueHover?: { legend?: string; y?: number; color?: string }[];\n hoverYValue?: string | number | null;\n hoverXValue?: string | number | null;\n xCalloutValue?: string;\n yCalloutValue?: string;\n lineColor?: string;\n hoveredLineColor?: string;\n selectedLegend?: string;\n containerWidth?: number;\n containerHeight?: number;\n}\n\nexport interface IRefArrayData {\n index?: string;\n refElement?: SVGGElement;\n}\n\nexport interface IMargins {\n /**\n * left margin for the chart.\n */\n left?: number;\n /**\n * Right margin for the chart.\n */\n right?: number;\n /**\n * Top margin for the chart.\n */\n top?: number;\n /**\n * Bottom margin for the chart.\n */\n bottom?: number;\n}\n\nexport interface IDataPoint {\n /**\n * Independent value of the data point, rendered along the x-axis.\n * If x is a number, then each y-coordinate is plotted at its x-coordinate.\n * If x is a string, then the data is evenly spaced along the x-axis.\n */\n x: number | string;\n\n /**\n * Dependent value of the data point, rendered along the y-axis.\n */\n y: number;\n\n // NOTE: VerticalStackedBarChart, PieChart\n /**\n * onClick action for each datapoint in the chart\n */\n onClick?: VoidFunction;\n}\n\nexport interface IHorizontalDataPoint {\n /**\n * Independent value of the data point, rendered along the x-axis.\n * If x is a number, then each y-coordinate is plotted at its x-coordinate.\n * If x is a string, then the data is evenly spaced along the x-axis.\n */\n x: number;\n\n /**\n * Dependent value of the data point, rendered along the y-axis.\n */\n y: number;\n}\n\nexport interface IChartDataPoint {\n /**\n * Legend text for the datapoint in the chart\n */\n legend?: string;\n\n /**\n * data the datapoint in the chart\n */\n data?: number;\n\n /**\n * data the datapoint in the chart\n */\n horizontalBarChartdata?: IHorizontalDataPoint;\n\n /**\n * onClick action for each datapoint in the chart\n */\n onClick?: VoidFunction;\n\n /**\n * Color for the legend in the chart. If not provided, it will fallback on the default color palette.\n */\n color?: string;\n\n /**\n * placeholder data point\n */\n placeHolder?: boolean;\n\n /**\n * Callout data for x axis\n * This is an optional prop, If haven;t given legend will take\n */\n xAxisCalloutData?: string;\n\n /**\n * Callout data for y axis\n * This is an optional prop, If haven't given data will take\n */\n yAxisCalloutData?: string;\n\n /**\n * Accessibility data for callout\n */\n callOutAccessibilityData?: IAccessibilityProps;\n}\n\nexport interface IVerticalBarChartDataPoint {\n /**\n * Independent value of the data point, rendered along the x-axis.\n * If x is a number, then each y-coordinate is plotted at its x-coordinate.\n * If x is a string, then the data is evenly spaced along the x-axis.\n */\n x: number | string;\n\n /**\n * Dependent value of the data point, rendered along the y-axis.\n */\n y: number;\n\n /**\n * Legend text for the datapoint in the chart\n */\n legend?: string;\n\n /**\n * color for the legend in the chart\n */\n color?: string;\n\n /**\n * Callout data for x axis\n * This is an optional prop, If haven;t given legend will take\n */\n xAxisCalloutData?: string;\n\n /**\n * Callout data for y axis\n * This is an optional prop, If haven't given data will take\n */\n yAxisCalloutData?: string;\n\n /**\n * data to render the line along with bars\n */\n lineData?: ILineDataInVerticalBarChart;\n\n /**\n * onClick action for each datapoint in the chart\n */\n onClick?: VoidFunction;\n\n /**\n * Accessibility data for callout\n */\n callOutAccessibilityData?: IAccessibilityProps;\n}\n\nexport interface IHorizontalBarChartWithAxisDataPoint {\n /**\n * Dependent value of the data point, rendered along the x-axis.\n */\n x: number;\n\n /**\n * Independent value of the data point, rendered along the y-axis.\n * If y is a number, then each y-coordinate is plotted at its y-coordinate.\n * If y is a string, then the data is evenly spaced along the y-axis.\n */\n y: number | string;\n\n /**\n * Legend text for the datapoint in the chart\n */\n legend?: string;\n\n /**\n * color for the legend in the chart\n */\n color?: string;\n\n /**\n * Callout data for x axis\n * This is an optional prop, If haven;t given legend will take\n */\n xAxisCalloutData?: string;\n\n /**\n * Callout data for y axis\n * This is an optional prop, If haven't given data will take\n */\n yAxisCalloutData?: string;\n\n /**\n * onClick action for each datapoint in the chart\n */\n onClick?: VoidFunction;\n\n /**\n * Accessibility data for callout\n */\n callOutAccessibilityData?: IAccessibilityProps;\n}\n\nexport interface ILineDataInVerticalBarChart {\n y: IVerticalBarChartDataPoint['y'];\n yAxisCalloutData?: string | undefined;\n\n /**\n * onClick action for each datapoint in the chart\n */\n onClick?: VoidFunction;\n /**\n * Whether to use the secondary y scale or not\n * False by default.\n */\n useSecondaryYScale?: boolean;\n}\n\nexport interface ILineChartDataPoint {\n /**\n * Independent value of the data point, rendered along the x-axis.\n * If x is a number, then each y-coordinate is plotted at its x-coordinate.\n * If data type on x is Date, then the data is spaced evenly by d3-scale\n */\n x: number | Date;\n\n /**\n * Dependent value of the data point, rendered along the y-axis.\n */\n y: number;\n\n /**\n * Defines the function that is executed on clicking line\n */\n onDataPointClick?: () => void;\n\n /**\n * Callout data for x axis\n */\n xAxisCalloutData?: string;\n\n /**\n * Callout data for y axis\n */\n yAxisCalloutData?: string | { [id: string]: number };\n\n /**\n * Whether to hide callout data for the point.\n */\n hideCallout?: boolean;\n\n /**\n * Accessibility data for callout\n */\n callOutAccessibilityData?: IAccessibilityProps;\n\n /**\n * X axis Accessibility data for callout\n */\n xAxisCalloutAccessibilityData?: IAccessibilityProps;\n}\n\nexport interface ILineChartGap {\n /**\n * Starting index of the gap.\n */\n startIndex: number;\n\n /**\n * Ending index of the gap.\n */\n endIndex: number;\n}\n\nexport interface ILineChartLineOptions extends SVGProps<SVGPathElement> {\n /**\n * Width of the line/stroke.\n * Overrides the strokeWidth set on ICartesianChartProps level.\n * @see https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-width\n */\n strokeWidth?: number | string;\n\n /**\n * Pattern of dashes and gaps.\n * @see https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray\n */\n strokeDasharray?: string | number;\n\n /**\n * Offset on rendering of stroke dash array.\n * @see https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dashoffset\n */\n strokeDashoffset?: string | number;\n\n /**\n * Shape at the end of a subpath.\n * Default round.\n * @see https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linecap\n */\n strokeLinecap?: 'butt' | 'round' | 'square' | 'inherit';\n\n /**\n * Width of border around the line. Default no border.\n */\n lineBorderWidth?: string | number;\n\n /**\n * Color of border around the line. Default white.\n */\n lineBorderColor?: string;\n}\n\nexport interface ILineChartPoints {\n /**\n * Legend text for the datapoint in the chart\n */\n legend: string;\n\n /**\n * The shape for the legend\n * default: show the rect legend\n */\n legendShape?: LegendShape;\n\n /**\n * dataPoints for the line chart\n */\n data: ILineChartDataPoint[];\n\n /**\n * gaps in the line chart where a line is not drawn\n */\n gaps?: ILineChartGap[];\n\n /**\n * color for the legend in the chart\n */\n color?: string;\n\n /**\n * opacity for chart fill color\n */\n opacity?: number;\n\n /**\n * options for the line drawn\n */\n lineOptions?: ILineChartLineOptions;\n\n /**\n * hide dots for points that are not active\n */\n hideNonActiveDots?: boolean;\n\n /**\n * Defines the function that is executed on clicking this legend\n */\n onLegendClick?: (selectedLegend: string | null | string[]) => void;\n\n /**\n * Defines the function that is executed on clicking line\n */\n onLineClick?: () => void;\n}\n\nexport interface IChartProps {\n /**\n * chart title for the chart\n */\n chartTitle?: string;\n\n /**\n * Accessibility data for chart title\n */\n chartTitleAccessibilityData?: IAccessibilityProps;\n /**\n * data for the points in the chart\n */\n chartData?: IChartDataPoint[];\n\n /**\n * Accessibility data for chart data\n */\n chartDataAccessibilityData?: IAccessibilityProps;\n\n /**\n * data for the points in the line chart\n */\n lineChartData?: ILineChartPoints[];\n\n /**\n * data for the points in the line chart\n */\n SankeyChartData?: ISankeyChartData;\n\n /**\n * data for the points in the line chart\n */\n pointOptions?: SVGProps<SVGCircleElement>;\n\n /**\n * data for the dotted line on hovering the point\n */\n pointLineOptions?: SVGProps<SVGLineElement>;\n}\n\nexport interface ISankeyChartData {\n nodes: SNode[];\n links: SLink[];\n}\n\ninterface ISNodeExtra {\n nodeId: number | string;\n name: string;\n color?: string;\n borderColor?: string;\n actualValue?: number;\n layer?: number;\n}\n\ninterface ISLinkExtra {\n source: number;\n target: number;\n value: number;\n unnormalizedValue?: number;\n}\n\nexport type SNode = d3Sankey.SankeyNode<ISNodeExtra, ISLinkExtra>;\nexport type SLink = d3Sankey.SankeyLink<ISNodeExtra, ISLinkExtra>;\n\nexport interface IAccessibilityProps {\n /**\n * Accessibility aria-label\n */\n ariaLabel?: string;\n\n /**\n * Accessibility aria-labelledBy\n */\n ariaLabelledBy?: string;\n\n /**\n * Accessibility aria-describedBy\n */\n ariaDescribedBy?: string;\n}\n\nexport interface IVSChartDataPoint {\n /**\n * data the datapoint in the chart\n */\n data: number;\n\n /**\n * Legend text for the datapoint in the chart\n */\n legend: string;\n\n /**\n * color for the legend in the chart\n */\n color?: string;\n\n /**\n * Callout data for x axis\n * This is an optional prop, If haven;t given legend will take\n */\n xAxisCalloutData?: string;\n\n /**\n * Callout data for y axis\n * This is an optional prop, If haven't given data will take\n */\n yAxisCalloutData?: string;\n\n /**\n * Accessibility data for callout\n */\n callOutAccessibilityData?: IAccessibilityProps;\n}\n\nexport interface IVerticalStackedChartProps {\n /**\n * data for the points in the chart\n */\n chartData: IVSChartDataPoint[];\n\n /**\n * Data for x axis label for multistacked Vertical bar chart\n */\n xAxisPoint: number | string;\n\n /**\n * Callout data for x axis\n * This is an optional prop, If haven't given, legend will take\n */\n xAxisCalloutData?: string;\n /**\n * line data to render lines on stacked bar chart\n */\n lineData?: ILineDataInVerticalStackedBarChart[];\n /**\n * Accessibility data for Whole stack callout\n */\n stackCallOutAccessibilityData?: IAccessibilityProps;\n}\n\nexport interface ILineDataInVerticalStackedBarChart {\n y: number;\n color: string;\n legend: string;\n /**\n * Data to show in callout\n */\n data?: number;\n yAxisCalloutData?: string;\n /**\n * Whether to use the secondary y scale or not\n * False by default.\n */\n useSecondaryYScale?: boolean;\n}\n\nexport interface IGVBarChartSeriesPoint {\n /**\n * Text for // need to check use of this\n */\n key: string;\n\n /**\n * Data for bar height of Grouped vertical bar chart\n */\n data: number;\n\n /**\n * Color for the legend in the chart\n */\n color: string;\n\n /**\n * Legend text in the chart\n */\n legend: string;\n\n /**\n * Callout data for x axis\n * This is an optional prop, If haven;t given legend will take\n */\n xAxisCalloutData?: string;\n\n /**\n * Callout data for y axis\n * This is an optional prop, If haven't given data will take\n */\n yAxisCalloutData?: string;\n\n /**\n * onClick action for each datapoint in the chart\n */\n onClick?: VoidFunction;\n\n /**\n * Accessibility data for callout\n */\n callOutAccessibilityData?: IAccessibilityProps;\n}\n\nexport interface IGroupedVerticalBarChartData {\n /**\n * Data for X axis label\n */\n name: string;\n\n /**\n * Data points for Grouped vertical bar chart\n */\n series: IGVBarChartSeriesPoint[];\n\n /**\n * Accessibility data for Group Bars Stack Callout\n */\n stackCallOutAccessibilityData?: IAccessibilityProps;\n}\n\nexport interface IGVDataPoint {\n /**\n * This interface used for - While forming datapoints from given prop \"data\" in code\n * datapoints are used for to draw graph\n */\n [key: string]: number | string;\n}\n\nexport interface IGVSingleDataPoint {\n /**\n * While forming datapoints from given prop \"data\" in code.\n * These datapoints are used for to draw graph easily.\n */\n [key: string]: IGVDataPoint;\n}\n\nexport interface IGVForBarChart {\n /**\n * While forming datapoints from given prop \"data\"\n * These datapoints are used for to draw graph.\n */\n [key: string]: IGVBarChartSeriesPoint;\n}\n\nexport interface IHeatMapChartDataPoint {\n x: string | Date | number;\n y: string | Date | number;\n value: number;\n /**\n * The value/ text to be rendered in the rectange\n */\n rectText?: string | number;\n /**\n * denomination to show in the callout\n */\n ratio?: [number, number];\n /**\n * description message to the callout\n */\n descriptionMessage?: string;\n\n /**\n * onClick action for each datapoint in the chart\n */\n onClick?: VoidFunction;\n /**\n * Accessibility data for callout\n */\n callOutAccessibilityData?: IAccessibilityProps;\n}\n\nexport interface IHeatMapChartData {\n /**\n * name of the legend\n */\n legend: string;\n data: IHeatMapChartDataPoint[];\n /**\n * This number will be used to get the color for the legend\n */\n value: number;\n}\n\nexport interface ICustomizedCalloutDataPoint {\n legend: string;\n y: number;\n color: string;\n xAxisCalloutData?: string;\n yAxisCalloutData?: string | { [id: string]: number };\n}\n\n/**\n * Used for custom callout data interface. As Area chart callout data will be prepared from given props.data,\n * Those required data passing to onRenderCalloutPerDataPoint and onRenderCalloutPerStack.\n */\nexport interface ICustomizedCalloutData {\n x: number | string | Date;\n values: ICustomizedCalloutDataPoint[];\n}\n"]}
1
+ {"version":3,"file":"IDataPoint.js","sourceRoot":"../src/","sources":["types/IDataPoint.ts"],"names":[],"mappings":"","sourcesContent":["import { SVGProps } from 'react';\nimport { LegendShape } from '../components/Legends/Legends.types';\nimport * as d3Sankey from 'd3-sankey';\nexport interface IBasestate {\n _width?: number;\n _height?: number;\n activeLegend?: string;\n color?: string;\n dataForHoverCard?: number;\n isCalloutVisible: boolean;\n isLegendSelected?: boolean;\n isLegendHovered?: boolean;\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n refSelected?: any;\n YValueHover?: { legend?: string; y?: number; color?: string }[];\n hoverYValue?: string | number | null;\n hoverXValue?: string | number | null;\n xCalloutValue?: string;\n yCalloutValue?: string;\n lineColor?: string;\n hoveredLineColor?: string;\n selectedLegend?: string;\n containerWidth?: number;\n containerHeight?: number;\n}\n\nexport interface IRefArrayData {\n index?: string;\n refElement?: SVGGElement;\n}\n\n/**\n * {@docCategory IChartProps}\n */\nexport interface IMargins {\n /**\n * left margin for the chart.\n */\n left?: number;\n /**\n * Right margin for the chart.\n */\n right?: number;\n /**\n * Top margin for the chart.\n */\n top?: number;\n /**\n * Bottom margin for the chart.\n */\n bottom?: number;\n}\n\n/**\n * {@docCategory IChartData}\n */\nexport interface IDataPoint {\n /**\n * Independent value of the data point, rendered along the x-axis.\n * If x is a number, then each y-coordinate is plotted at its x-coordinate.\n * If x is a string, then the data is evenly spaced along the x-axis.\n */\n x: number | string;\n\n /**\n * Dependent value of the data point, rendered along the y-axis.\n */\n y: number;\n\n // NOTE: VerticalStackedBarChart, PieChart\n /**\n * onClick action for each datapoint in the chart\n */\n onClick?: VoidFunction;\n}\n\n/**\n * {@docCategory IChartData}\n */\nexport interface IHorizontalDataPoint {\n /**\n * Independent value of the data point, rendered along the x-axis.\n * If x is a number, then each y-coordinate is plotted at its x-coordinate.\n * If x is a string, then the data is evenly spaced along the x-axis.\n */\n x: number;\n\n /**\n * Dependent value of the data point, rendered along the y-axis.\n */\n y: number;\n}\n\n/**\n * {@docCategory IChartData}\n */\nexport interface IChartDataPoint {\n /**\n * Legend text for the datapoint in the chart\n */\n legend?: string;\n\n /**\n * data the datapoint in the chart\n */\n data?: number;\n\n /**\n * data the datapoint in the chart\n */\n horizontalBarChartdata?: IHorizontalDataPoint;\n\n /**\n * onClick action for each datapoint in the chart\n */\n onClick?: VoidFunction;\n\n /**\n * Color for the legend in the chart. If not provided, it will fallback on the default color palette.\n */\n color?: string;\n\n /**\n * placeholder data point\n */\n placeHolder?: boolean;\n\n /**\n * Callout data for x axis\n * This is an optional prop, If haven;t given legend will take\n */\n xAxisCalloutData?: string;\n\n /**\n * Callout data for y axis\n * This is an optional prop, If haven't given data will take\n */\n yAxisCalloutData?: string;\n\n /**\n * Accessibility data for callout\n */\n callOutAccessibilityData?: IAccessibilityProps;\n}\n\n/**\n * {@docCategory IChartData}\n */\nexport interface IVerticalBarChartDataPoint {\n /**\n * Independent value of the data point, rendered along the x-axis.\n * If x is a number, then each y-coordinate is plotted at its x-coordinate.\n * If x is a string, then the data is evenly spaced along the x-axis.\n */\n x: number | string;\n\n /**\n * Dependent value of the data point, rendered along the y-axis.\n */\n y: number;\n\n /**\n * Legend text for the datapoint in the chart\n */\n legend?: string;\n\n /**\n * color for the legend in the chart\n */\n color?: string;\n\n /**\n * Callout data for x axis\n * This is an optional prop, If haven;t given legend will take\n */\n xAxisCalloutData?: string;\n\n /**\n * Callout data for y axis\n * This is an optional prop, If haven't given data will take\n */\n yAxisCalloutData?: string;\n\n /**\n * data to render the line along with bars\n */\n lineData?: ILineDataInVerticalBarChart;\n\n /**\n * onClick action for each datapoint in the chart\n */\n onClick?: VoidFunction;\n\n /**\n * Accessibility data for callout\n */\n callOutAccessibilityData?: IAccessibilityProps;\n}\n\n/**\n * {@docCategory IChartData}\n */\nexport interface IHorizontalBarChartWithAxisDataPoint {\n /**\n * Dependent value of the data point, rendered along the x-axis.\n */\n x: number;\n\n /**\n * Independent value of the data point, rendered along the y-axis.\n * If y is a number, then each y-coordinate is plotted at its y-coordinate.\n * If y is a string, then the data is evenly spaced along the y-axis.\n */\n y: number | string;\n\n /**\n * Legend text for the datapoint in the chart\n */\n legend?: string;\n\n /**\n * color for the legend in the chart\n */\n color?: string;\n\n /**\n * Callout data for x axis\n * This is an optional prop, If haven;t given legend will take\n */\n xAxisCalloutData?: string;\n\n /**\n * Callout data for y axis\n * This is an optional prop, If haven't given data will take\n */\n yAxisCalloutData?: string;\n\n /**\n * onClick action for each datapoint in the chart\n */\n onClick?: VoidFunction;\n\n /**\n * Accessibility data for callout\n */\n callOutAccessibilityData?: IAccessibilityProps;\n}\n\n/**\n * {@docCategory IChartData}\n */\nexport interface ILineDataInVerticalBarChart {\n y: IVerticalBarChartDataPoint['y'];\n yAxisCalloutData?: string | undefined;\n\n /**\n * onClick action for each datapoint in the chart\n */\n onClick?: VoidFunction;\n /**\n * Whether to use the secondary y scale or not\n * False by default.\n */\n useSecondaryYScale?: boolean;\n}\n\n/**\n * {@docCategory IChartData}\n */\nexport interface ILineChartDataPoint {\n /**\n * Independent value of the data point, rendered along the x-axis.\n * If x is a number, then each y-coordinate is plotted at its x-coordinate.\n * If data type on x is Date, then the data is spaced evenly by d3-scale\n */\n x: number | Date;\n\n /**\n * Dependent value of the data point, rendered along the y-axis.\n */\n y: number;\n\n /**\n * Defines the function that is executed on clicking line\n */\n onDataPointClick?: () => void;\n\n /**\n * Callout data for x axis\n */\n xAxisCalloutData?: string;\n\n /**\n * Callout data for y axis\n */\n yAxisCalloutData?: string | { [id: string]: number };\n\n /**\n * Whether to hide callout data for the point.\n */\n hideCallout?: boolean;\n\n /**\n * Accessibility data for callout\n */\n callOutAccessibilityData?: IAccessibilityProps;\n\n /**\n * X axis Accessibility data for callout\n */\n xAxisCalloutAccessibilityData?: IAccessibilityProps;\n}\n\n/**\n * {@docCategory IChartData}\n */\nexport interface ILineChartGap {\n /**\n * Starting index of the gap.\n */\n startIndex: number;\n\n /**\n * Ending index of the gap.\n */\n endIndex: number;\n}\n\n/**\n * {@docCategory IChartProps}\n */\nexport interface ILineChartLineOptions extends SVGProps<SVGPathElement> {\n /**\n * Width of the line/stroke.\n * Overrides the strokeWidth set on ICartesianChartProps level.\n * @see https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-width\n */\n strokeWidth?: number | string;\n\n /**\n * Pattern of dashes and gaps.\n * @see https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray\n */\n strokeDasharray?: string | number;\n\n /**\n * Offset on rendering of stroke dash array.\n * @see https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dashoffset\n */\n strokeDashoffset?: string | number;\n\n /**\n * Shape at the end of a subpath.\n * Default round.\n * @see https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linecap\n */\n strokeLinecap?: 'butt' | 'round' | 'square' | 'inherit';\n\n /**\n * Width of border around the line. Default no border.\n */\n lineBorderWidth?: string | number;\n\n /**\n * Color of border around the line. Default white.\n */\n lineBorderColor?: string;\n}\n\n/**\n * {@docCategory IChartData}\n */\nexport interface ILineChartPoints {\n /**\n * Legend text for the datapoint in the chart\n */\n legend: string;\n\n /**\n * The shape for the legend\n * default: show the rect legend\n */\n legendShape?: LegendShape;\n\n /**\n * dataPoints for the line chart\n */\n data: ILineChartDataPoint[];\n\n /**\n * gaps in the line chart where a line is not drawn\n */\n gaps?: ILineChartGap[];\n\n /**\n * color for the legend in the chart\n */\n color?: string;\n\n /**\n * opacity for chart fill color\n */\n opacity?: number;\n\n /**\n * options for the line drawn\n */\n lineOptions?: ILineChartLineOptions;\n\n /**\n * hide dots for points that are not active\n */\n hideNonActiveDots?: boolean;\n\n /**\n * Defines the function that is executed on clicking this legend\n */\n onLegendClick?: (selectedLegend: string | null | string[]) => void;\n\n /**\n * Defines the function that is executed on clicking line\n */\n onLineClick?: () => void;\n}\n\n/**\n * {@docCategory IChartProps}\n */\nexport interface IChartProps {\n /**\n * chart title for the chart\n */\n chartTitle?: string;\n\n /**\n * Accessibility data for chart title\n */\n chartTitleAccessibilityData?: IAccessibilityProps;\n /**\n * data for the points in the chart\n */\n chartData?: IChartDataPoint[];\n\n /**\n * Accessibility data for chart data\n */\n chartDataAccessibilityData?: IAccessibilityProps;\n\n /**\n * data for the points in the line chart\n */\n lineChartData?: ILineChartPoints[];\n\n /**\n * data for the points in the line chart\n */\n SankeyChartData?: ISankeyChartData;\n\n /**\n * data for the points in the line chart\n */\n pointOptions?: SVGProps<SVGCircleElement>;\n\n /**\n * data for the dotted line on hovering the point\n */\n pointLineOptions?: SVGProps<SVGLineElement>;\n}\n\n/**\n * {@docCategory IChartData}\n */\nexport interface ISankeyChartData {\n nodes: SNode[];\n links: SLink[];\n}\n\ninterface ISNodeExtra {\n nodeId: number | string;\n name: string;\n color?: string;\n borderColor?: string;\n actualValue?: number;\n layer?: number;\n}\n\ninterface ISLinkExtra {\n source: number;\n target: number;\n value: number;\n unnormalizedValue?: number;\n}\n\nexport type SNode = d3Sankey.SankeyNode<ISNodeExtra, ISLinkExtra>;\nexport type SLink = d3Sankey.SankeyLink<ISNodeExtra, ISLinkExtra>;\n\n/**\n * {@docCategory IChartProps}\n */\nexport interface IAccessibilityProps {\n /**\n * Accessibility aria-label\n */\n ariaLabel?: string;\n\n /**\n * Accessibility aria-labelledBy\n */\n ariaLabelledBy?: string;\n\n /**\n * Accessibility aria-describedBy\n */\n ariaDescribedBy?: string;\n}\n\n/**\n * {@docCategory IChartData}\n */\nexport interface IVSChartDataPoint {\n /**\n * data the datapoint in the chart\n */\n data: number;\n\n /**\n * Legend text for the datapoint in the chart\n */\n legend: string;\n\n /**\n * color for the legend in the chart\n */\n color?: string;\n\n /**\n * Callout data for x axis\n * This is an optional prop, If haven;t given legend will take\n */\n xAxisCalloutData?: string;\n\n /**\n * Callout data for y axis\n * This is an optional prop, If haven't given data will take\n */\n yAxisCalloutData?: string;\n\n /**\n * Accessibility data for callout\n */\n callOutAccessibilityData?: IAccessibilityProps;\n}\n\n/**\n * {@docCategory IChartProps}\n */\nexport interface IVerticalStackedChartProps {\n /**\n * data for the points in the chart\n */\n chartData: IVSChartDataPoint[];\n\n /**\n * Data for x axis label for multistacked Vertical bar chart\n */\n xAxisPoint: number | string;\n\n /**\n * Callout data for x axis\n * This is an optional prop, If haven't given, legend will take\n */\n xAxisCalloutData?: string;\n /**\n * line data to render lines on stacked bar chart\n */\n lineData?: ILineDataInVerticalStackedBarChart[];\n /**\n * Accessibility data for Whole stack callout\n */\n stackCallOutAccessibilityData?: IAccessibilityProps;\n}\n\n/**\n * {@docCategory IChartData}\n */\nexport interface ILineDataInVerticalStackedBarChart {\n y: number;\n color: string;\n legend: string;\n /**\n * Data to show in callout\n */\n data?: number;\n yAxisCalloutData?: string;\n /**\n * Whether to use the secondary y scale or not\n * False by default.\n */\n useSecondaryYScale?: boolean;\n}\n\n/**\n * {@docCategory IChartData}\n */\nexport interface IGVBarChartSeriesPoint {\n /**\n * Text for // need to check use of this\n */\n key: string;\n\n /**\n * Data for bar height of Grouped vertical bar chart\n */\n data: number;\n\n /**\n * Color for the legend in the chart\n */\n color: string;\n\n /**\n * Legend text in the chart\n */\n legend: string;\n\n /**\n * Callout data for x axis\n * This is an optional prop, If haven;t given legend will take\n */\n xAxisCalloutData?: string;\n\n /**\n * Callout data for y axis\n * This is an optional prop, If haven't given data will take\n */\n yAxisCalloutData?: string;\n\n /**\n * onClick action for each datapoint in the chart\n */\n onClick?: VoidFunction;\n\n /**\n * Accessibility data for callout\n */\n callOutAccessibilityData?: IAccessibilityProps;\n}\n\n/**\n * {@docCategory IChartData}\n */\nexport interface IGroupedVerticalBarChartData {\n /**\n * Data for X axis label\n */\n name: string;\n\n /**\n * Data points for Grouped vertical bar chart\n */\n series: IGVBarChartSeriesPoint[];\n\n /**\n * Accessibility data for Group Bars Stack Callout\n */\n stackCallOutAccessibilityData?: IAccessibilityProps;\n}\n\nexport interface IGVDataPoint {\n /**\n * This interface used for - While forming datapoints from given prop \"data\" in code\n * datapoints are used for to draw graph\n */\n [key: string]: number | string;\n}\n\nexport interface IGVSingleDataPoint {\n /**\n * While forming datapoints from given prop \"data\" in code.\n * These datapoints are used for to draw graph easily.\n */\n [key: string]: IGVDataPoint;\n}\n\nexport interface IGVForBarChart {\n /**\n * While forming datapoints from given prop \"data\"\n * These datapoints are used for to draw graph.\n */\n [key: string]: IGVBarChartSeriesPoint;\n}\n\n/**\n * {@docCategory IChartData}\n */\nexport interface IHeatMapChartDataPoint {\n x: string | Date | number;\n y: string | Date | number;\n value: number;\n /**\n * The value/ text to be rendered in the rectange\n */\n rectText?: string | number;\n /**\n * denomination to show in the callout\n */\n ratio?: [number, number];\n /**\n * description message to the callout\n */\n descriptionMessage?: string;\n\n /**\n * onClick action for each datapoint in the chart\n */\n onClick?: VoidFunction;\n /**\n * Accessibility data for callout\n */\n callOutAccessibilityData?: IAccessibilityProps;\n}\n\n/**\n * {@docCategory IChartData}\n */\nexport interface IHeatMapChartData {\n /**\n * name of the legend\n */\n legend: string;\n data: IHeatMapChartDataPoint[];\n /**\n * This number will be used to get the color for the legend\n */\n value: number;\n}\n\n/**\n * {@docCategory IChartData}\n */\nexport interface ICustomizedCalloutDataPoint {\n legend: string;\n y: number;\n color: string;\n xAxisCalloutData?: string;\n yAxisCalloutData?: string | { [id: string]: number };\n}\n\n/**\n * Used for custom callout data interface. As Area chart callout data will be prepared from given props.data,\n * Those required data passing to onRenderCalloutPerDataPoint and onRenderCalloutPerStack.\n * {@docCategory IChartData}\n */\nexport interface ICustomizedCalloutData {\n x: number | string | Date;\n values: ICustomizedCalloutDataPoint[];\n}\n"]}
package/lib/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  // Do not modify this file; it is generated as part of publish.
2
2
  // The checked in version is a placeholder only and will not be updated.
3
3
  import { setVersion } from '@fluentui/set-version';
4
- setVersion('@fluentui/react-charting', '5.18.8');
4
+ setVersion('@fluentui/react-charting', '5.18.10');
5
5
  //# sourceMappingURL=version.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"version.js","sourceRoot":"../src/","sources":["version.ts"],"names":[],"mappings":"AAAA,+DAA+D;AAC/D,wEAAwE;AACxE,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,UAAU,CAAC,0BAA0B,EAAE,QAAQ,CAAC,CAAC","sourcesContent":["// Do not modify this file; it is generated as part of publish.\n// The checked in version is a placeholder only and will not be updated.\nimport { setVersion } from '@fluentui/set-version';\nsetVersion('@fluentui/react-charting', '5.18.8');"]}
1
+ {"version":3,"file":"version.js","sourceRoot":"../src/","sources":["version.ts"],"names":[],"mappings":"AAAA,+DAA+D;AAC/D,wEAAwE;AACxE,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,UAAU,CAAC,0BAA0B,EAAE,SAAS,CAAC,CAAC","sourcesContent":["// Do not modify this file; it is generated as part of publish.\n// The checked in version is a placeholder only and will not be updated.\nimport { setVersion } from '@fluentui/set-version';\nsetVersion('@fluentui/react-charting', '5.18.10');"]}
@@ -3,7 +3,7 @@ import { IChartProps, IRefArrayData, IBasestate, ILineChartDataPoint, ILineChart
3
3
  import { ICartesianChartStyles, ICartesianChartStyleProps, ICartesianChartProps, IChildProps } from '../CommonComponents/CartesianChart.types';
4
4
  export type { IChildProps, IRefArrayData, IBasestate, ILineChartDataPoint, ILineChartPoints, IMargins };
5
5
  /**
6
- * IAreaChartProps properties for area chart.
6
+ * Area Chart properties.
7
7
  * {@docCategory AreaChart}
8
8
  */
9
9
  export interface IAreaChartProps extends ICartesianChartProps {
@@ -40,7 +40,15 @@ export interface IAreaChartProps extends ICartesianChartProps {
40
40
  enablePerfOptimization?: boolean;
41
41
  optimizeLargeData?: boolean;
42
42
  }
43
+ /**
44
+ * Area Chart styles
45
+ * {@docCategory AreaChart}
46
+ */
43
47
  export interface IAreaChartStyles extends ICartesianChartStyles {
44
48
  }
49
+ /**
50
+ * Area Chart style properties
51
+ * {@docCategory AreaChart}
52
+ */
45
53
  export interface IAreaChartStyleProps extends ICartesianChartStyleProps {
46
54
  }
@@ -1 +1 @@
1
- {"version":3,"file":"AreaChart.types.js","sourceRoot":"../src/","sources":["components/AreaChart/AreaChart.types.ts"],"names":[],"mappings":"","sourcesContent":["import { IRenderFunction, IStyleFunctionOrObject } from '@fluentui/react/lib/Utilities';\nimport {\n IChartProps,\n IRefArrayData,\n IBasestate,\n ILineChartDataPoint,\n ILineChartPoints,\n ICustomizedCalloutData,\n IMargins,\n} from '../../types/index';\nimport {\n ICartesianChartStyles,\n ICartesianChartStyleProps,\n ICartesianChartProps,\n IChildProps,\n} from '../CommonComponents/CartesianChart.types';\n\nexport type { IChildProps, IRefArrayData, IBasestate, ILineChartDataPoint, ILineChartPoints, IMargins };\n\n/**\n * IAreaChartProps properties for area chart.\n * {@docCategory AreaChart}\n */\nexport interface IAreaChartProps extends ICartesianChartProps {\n /**\n * Data to render in the chart.\n */\n data: IChartProps;\n\n /**\n * This prop is used to draw Y axis grid lines on the chart. Default value will be false\n * @deprecated now lines are shown by default\n * no need to use this prop\n */\n showYAxisGridLines?: boolean;\n\n /**\n * Call to provide customized styling that will layer on top of the variant rules.\n */\n styles?: IStyleFunctionOrObject<ICartesianChartStyleProps, ICartesianChartStyles>;\n\n /**\n * Define a custom callout renderer for a data point\n */\n onRenderCalloutPerDataPoint?: IRenderFunction<ICustomizedCalloutData>;\n\n /**\n * Define a custom callout renderer for a stack; default is to render per data point\n */\n onRenderCalloutPerStack?: IRenderFunction<ICustomizedCalloutData>;\n\n /**\n * The prop used to define the culture to localized the numbers\n */\n culture?: string;\n\n /**\n * @default false\n * The prop used to enable the perf optimization\n */\n enablePerfOptimization?: boolean;\n\n /*\n * Optimize area chart rendering for large data set.\n */\n optimizeLargeData?: boolean;\n}\n\nexport interface IAreaChartStyles extends ICartesianChartStyles {}\n\nexport interface IAreaChartStyleProps extends ICartesianChartStyleProps {}\n"]}
1
+ {"version":3,"file":"AreaChart.types.js","sourceRoot":"../src/","sources":["components/AreaChart/AreaChart.types.ts"],"names":[],"mappings":"","sourcesContent":["import { IRenderFunction, IStyleFunctionOrObject } from '@fluentui/react/lib/Utilities';\nimport {\n IChartProps,\n IRefArrayData,\n IBasestate,\n ILineChartDataPoint,\n ILineChartPoints,\n ICustomizedCalloutData,\n IMargins,\n} from '../../types/index';\nimport {\n ICartesianChartStyles,\n ICartesianChartStyleProps,\n ICartesianChartProps,\n IChildProps,\n} from '../CommonComponents/CartesianChart.types';\n\nexport type { IChildProps, IRefArrayData, IBasestate, ILineChartDataPoint, ILineChartPoints, IMargins };\n\n/**\n * Area Chart properties.\n * {@docCategory AreaChart}\n */\nexport interface IAreaChartProps extends ICartesianChartProps {\n /**\n * Data to render in the chart.\n */\n data: IChartProps;\n\n /**\n * This prop is used to draw Y axis grid lines on the chart. Default value will be false\n * @deprecated now lines are shown by default\n * no need to use this prop\n */\n showYAxisGridLines?: boolean;\n\n /**\n * Call to provide customized styling that will layer on top of the variant rules.\n */\n styles?: IStyleFunctionOrObject<ICartesianChartStyleProps, ICartesianChartStyles>;\n\n /**\n * Define a custom callout renderer for a data point\n */\n onRenderCalloutPerDataPoint?: IRenderFunction<ICustomizedCalloutData>;\n\n /**\n * Define a custom callout renderer for a stack; default is to render per data point\n */\n onRenderCalloutPerStack?: IRenderFunction<ICustomizedCalloutData>;\n\n /**\n * The prop used to define the culture to localized the numbers\n */\n culture?: string;\n\n /**\n * @default false\n * The prop used to enable the perf optimization\n */\n enablePerfOptimization?: boolean;\n\n /*\n * Optimize area chart rendering for large data set.\n */\n optimizeLargeData?: boolean;\n}\n\n/**\n * Area Chart styles\n * {@docCategory AreaChart}\n */\nexport interface IAreaChartStyles extends ICartesianChartStyles {}\n\n/**\n * Area Chart style properties\n * {@docCategory AreaChart}\n */\nexport interface IAreaChartStyleProps extends ICartesianChartStyleProps {}\n"]}
@@ -468,6 +468,7 @@ define(["require", "exports", "tslib", "react", "react", "@fluentui/react/lib/Ut
468
468
  return false;
469
469
  };
470
470
  CartesianChartBase.prototype._getCalloutContent = function (xValue, index, yValueHoverSubCountsExists, isLast) {
471
+ var _a;
471
472
  var marginStyle = isLast ? {} : { marginRight: '16px' };
472
473
  var toDrawShape = xValue.index !== undefined && xValue.index !== -1;
473
474
  var _classNames = getClassNames(this.props.styles, {
@@ -496,7 +497,7 @@ define(["require", "exports", "tslib", "react", "react", "@fluentui/react/lib/Ut
496
497
  React.createElement("div", { className: _classNames.calloutlegendText },
497
498
  " ",
498
499
  xValue.legend),
499
- React.createElement("div", { className: _classNames.calloutContentY }, (0, index_1.convertToLocaleString)(xValue.yAxisCalloutData ? xValue.yAxisCalloutData : xValue.y || xValue.data, culture))))));
500
+ React.createElement("div", { className: _classNames.calloutContentY }, (0, index_1.convertToLocaleString)(xValue.yAxisCalloutData ? xValue.yAxisCalloutData : (_a = xValue.y) !== null && _a !== void 0 ? _a : xValue.data, culture))))));
500
501
  }
501
502
  else {
502
503
  var subcounts_1 = xValue.yAxisCalloutData;