@undp/data-viz 2.4.1 → 2.5.0

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 (262) hide show
  1. package/dist/AreaChart.cjs +1 -1
  2. package/dist/AreaChart.cjs.map +1 -1
  3. package/dist/AreaChart.d.ts +11 -9
  4. package/dist/AreaChart.js +320 -322
  5. package/dist/AreaChart.js.map +1 -1
  6. package/dist/BarGraph.cjs +1 -1
  7. package/dist/BarGraph.cjs.map +1 -1
  8. package/dist/BarGraph.d.ts +15 -25
  9. package/dist/BarGraph.js +1694 -1694
  10. package/dist/BarGraph.js.map +1 -1
  11. package/dist/BasicStatCard.cjs +1 -1
  12. package/dist/BasicStatCard.cjs.map +1 -1
  13. package/dist/BasicStatCard.d.ts +13 -9
  14. package/dist/BasicStatCard.js +79 -81
  15. package/dist/BasicStatCard.js.map +1 -1
  16. package/dist/BeeSwarmChart.cjs +1 -1
  17. package/dist/BeeSwarmChart.cjs.map +1 -1
  18. package/dist/BeeSwarmChart.d.ts +11 -9
  19. package/dist/BeeSwarmChart.js +335 -336
  20. package/dist/BeeSwarmChart.js.map +1 -1
  21. package/dist/BiVariateChoroplethMap.cjs +1 -1
  22. package/dist/BiVariateChoroplethMap.cjs.map +1 -1
  23. package/dist/BiVariateChoroplethMap.d.ts +13 -3
  24. package/dist/BiVariateChoroplethMap.js +247 -245
  25. package/dist/BiVariateChoroplethMap.js.map +1 -1
  26. package/dist/BulletChart.cjs +1 -1
  27. package/dist/BulletChart.cjs.map +1 -1
  28. package/dist/BulletChart.d.ts +11 -5
  29. package/dist/BulletChart.js +560 -559
  30. package/dist/BulletChart.js.map +1 -1
  31. package/dist/ButterflyChart.cjs +1 -1
  32. package/dist/ButterflyChart.cjs.map +1 -1
  33. package/dist/ButterflyChart.d.ts +11 -9
  34. package/dist/ButterflyChart.js +348 -350
  35. package/dist/ButterflyChart.js.map +1 -1
  36. package/dist/ChoroplethMap.cjs +1 -1
  37. package/dist/ChoroplethMap.cjs.map +1 -1
  38. package/dist/ChoroplethMap.d.ts +11 -3
  39. package/dist/ChoroplethMap.js +213 -213
  40. package/dist/ChoroplethMap.js.map +1 -1
  41. package/dist/CirclePackingGraph.cjs +1 -1
  42. package/dist/CirclePackingGraph.d.ts +11 -9
  43. package/dist/CirclePackingGraph.js +1 -1
  44. package/dist/DataCards.cjs +1 -1
  45. package/dist/DataCards.d.ts +1 -1
  46. package/dist/DataCards.js +1 -1
  47. package/dist/DataTable.cjs +1 -1
  48. package/dist/DataTable.cjs.map +1 -1
  49. package/dist/DataTable.d.ts +4 -5
  50. package/dist/DataTable.js +114 -116
  51. package/dist/DataTable.js.map +1 -1
  52. package/dist/{DetailsModal-jmmKRMRM.cjs → DetailsModal-Du8Fr1QD.cjs} +2 -2
  53. package/dist/{DetailsModal-jmmKRMRM.cjs.map → DetailsModal-Du8Fr1QD.cjs.map} +1 -1
  54. package/dist/{DetailsModal-B2XBWR7w.js → DetailsModal-GqEbGHY2.js} +2 -2
  55. package/dist/{DetailsModal-B2XBWR7w.js.map → DetailsModal-GqEbGHY2.js.map} +1 -1
  56. package/dist/DifferenceLineChart.cjs +1 -1
  57. package/dist/DifferenceLineChart.cjs.map +1 -1
  58. package/dist/DifferenceLineChart.d.ts +11 -9
  59. package/dist/DifferenceLineChart.js +502 -504
  60. package/dist/DifferenceLineChart.js.map +1 -1
  61. package/dist/DonutChart.cjs +1 -1
  62. package/dist/DonutChart.cjs.map +1 -1
  63. package/dist/DonutChart.d.ts +14 -9
  64. package/dist/DonutChart.js +174 -179
  65. package/dist/DonutChart.js.map +1 -1
  66. package/dist/DotDensityMap.cjs +1 -1
  67. package/dist/DotDensityMap.d.ts +1 -1
  68. package/dist/DotDensityMap.js +2 -2
  69. package/dist/DualAxisLineChart.cjs +1 -1
  70. package/dist/DualAxisLineChart.cjs.map +1 -1
  71. package/dist/DualAxisLineChart.d.ts +13 -9
  72. package/dist/DualAxisLineChart.js +341 -351
  73. package/dist/DualAxisLineChart.js.map +1 -1
  74. package/dist/DumbbellChart.cjs +1 -1
  75. package/dist/DumbbellChart.cjs.map +1 -1
  76. package/dist/DumbbellChart.d.ts +11 -9
  77. package/dist/DumbbellChart.js +592 -593
  78. package/dist/DumbbellChart.js.map +1 -1
  79. package/dist/GeoHubCompareMaps.cjs +1 -1
  80. package/dist/GeoHubCompareMaps.d.ts +1 -1
  81. package/dist/GeoHubCompareMaps.js +1 -1
  82. package/dist/GeoHubMap.cjs +1 -1
  83. package/dist/GeoHubMap.d.ts +1 -1
  84. package/dist/GeoHubMap.js +1 -1
  85. package/dist/GeoHubMapWithLayerSelection.cjs +1 -1
  86. package/dist/GeoHubMapWithLayerSelection.d.ts +1 -1
  87. package/dist/GeoHubMapWithLayerSelection.js +1 -1
  88. package/dist/GraphEl-B7x5ku_y.cjs +2 -0
  89. package/dist/GraphEl-B7x5ku_y.cjs.map +1 -0
  90. package/dist/GraphEl-B8tGXqWk.js +1829 -0
  91. package/dist/GraphEl-B8tGXqWk.js.map +1 -0
  92. package/dist/GriddedGraphs.cjs +1 -1
  93. package/dist/GriddedGraphs.d.ts +28 -16
  94. package/dist/GriddedGraphs.js +1 -1
  95. package/dist/GriddedGraphsFromConfig.d.ts +28 -16
  96. package/dist/HeatMap.cjs +1 -1
  97. package/dist/HeatMap.cjs.map +1 -1
  98. package/dist/HeatMap.d.ts +11 -9
  99. package/dist/HeatMap.js +203 -205
  100. package/dist/HeatMap.js.map +1 -1
  101. package/dist/Histogram.cjs +1 -1
  102. package/dist/Histogram.cjs.map +1 -1
  103. package/dist/Histogram.d.ts +11 -5
  104. package/dist/Histogram.js +88 -89
  105. package/dist/Histogram.js.map +1 -1
  106. package/dist/HybridMap.cjs +1 -1
  107. package/dist/HybridMap.cjs.map +1 -1
  108. package/dist/HybridMap.d.ts +11 -3
  109. package/dist/HybridMap.js +279 -279
  110. package/dist/HybridMap.js.map +1 -1
  111. package/dist/LineChartWithConfidenceInterval.cjs +1 -1
  112. package/dist/LineChartWithConfidenceInterval.cjs.map +1 -1
  113. package/dist/LineChartWithConfidenceInterval.d.ts +11 -9
  114. package/dist/LineChartWithConfidenceInterval.js +393 -395
  115. package/dist/LineChartWithConfidenceInterval.js.map +1 -1
  116. package/dist/LinearColorLegend.cjs +1 -1
  117. package/dist/LinearColorLegend.js +1 -1
  118. package/dist/MultiGraphDashboard.d.ts +28 -16
  119. package/dist/MultiGraphDashboardFromConfig.d.ts +28 -16
  120. package/dist/MultiGraphDashboardWideToLongFormat.d.ts +1 -1
  121. package/dist/MultiGraphDashboardWideToLongFormatFromConfig.d.ts +1 -1
  122. package/dist/MultiLineAltChart.cjs +1 -1
  123. package/dist/MultiLineAltChart.cjs.map +1 -1
  124. package/dist/MultiLineAltChart.d.ts +11 -9
  125. package/dist/MultiLineAltChart.js +411 -413
  126. package/dist/MultiLineAltChart.js.map +1 -1
  127. package/dist/MultiLineChart.cjs +1 -1
  128. package/dist/MultiLineChart.cjs.map +1 -1
  129. package/dist/MultiLineChart.d.ts +11 -9
  130. package/dist/MultiLineChart.js +438 -440
  131. package/dist/MultiLineChart.js.map +1 -1
  132. package/dist/ParetoChart.cjs +1 -1
  133. package/dist/ParetoChart.cjs.map +1 -1
  134. package/dist/ParetoChart.d.ts +13 -13
  135. package/dist/ParetoChart.js +347 -355
  136. package/dist/ParetoChart.js.map +1 -1
  137. package/dist/PerformanceIntensiveMultiGraphDashboard.d.ts +28 -16
  138. package/dist/PerformanceIntensiveMultiGraphDashboardFromConfig.d.ts +28 -16
  139. package/dist/PerformanceIntensiveScrollStory.d.ts +28 -16
  140. package/dist/RadarChart.cjs +1 -1
  141. package/dist/RadarChart.cjs.map +1 -1
  142. package/dist/RadarChart.d.ts +11 -5
  143. package/dist/RadarChart.js +213 -213
  144. package/dist/RadarChart.js.map +1 -1
  145. package/dist/SankeyChart.cjs +1 -1
  146. package/dist/SankeyChart.cjs.map +1 -1
  147. package/dist/SankeyChart.d.ts +11 -9
  148. package/dist/SankeyChart.js +448 -450
  149. package/dist/SankeyChart.js.map +1 -1
  150. package/dist/ScatterPlot.cjs +1 -1
  151. package/dist/ScatterPlot.cjs.map +1 -1
  152. package/dist/ScatterPlot.d.ts +13 -13
  153. package/dist/ScatterPlot.js +490 -498
  154. package/dist/ScatterPlot.js.map +1 -1
  155. package/dist/ScrollStory.d.ts +28 -16
  156. package/dist/SimpleLineChart.cjs +1 -1
  157. package/dist/SimpleLineChart.cjs.map +1 -1
  158. package/dist/SimpleLineChart.d.ts +11 -9
  159. package/dist/SimpleLineChart.js +362 -364
  160. package/dist/SimpleLineChart.js.map +1 -1
  161. package/dist/SingleGraphDashboard.cjs +1 -1
  162. package/dist/SingleGraphDashboard.d.ts +28 -16
  163. package/dist/SingleGraphDashboard.js +1 -1
  164. package/dist/SingleGraphDashboardFromConfig.d.ts +28 -16
  165. package/dist/SingleGraphDashboardGeoHubMaps.d.ts +28 -16
  166. package/dist/SingleGraphDashboardGeoHubMapsFromConfig.d.ts +28 -16
  167. package/dist/SingleGraphDashboardThreeDGraphs.cjs +1 -1
  168. package/dist/SingleGraphDashboardThreeDGraphs.cjs.map +1 -1
  169. package/dist/SingleGraphDashboardThreeDGraphs.d.ts +28 -16
  170. package/dist/SingleGraphDashboardThreeDGraphs.js +40 -39
  171. package/dist/SingleGraphDashboardThreeDGraphs.js.map +1 -1
  172. package/dist/SingleGraphDashboardThreeDGraphsFromConfig.d.ts +28 -16
  173. package/dist/SlopeChart.cjs +1 -1
  174. package/dist/SlopeChart.d.ts +1 -1
  175. package/dist/SlopeChart.js +2 -2
  176. package/dist/SparkLine.cjs +1 -1
  177. package/dist/SparkLine.d.ts +1 -1
  178. package/dist/SparkLine.js +1 -1
  179. package/dist/StatCardFromData.cjs +1 -1
  180. package/dist/StatCardFromData.cjs.map +1 -1
  181. package/dist/StatCardFromData.d.ts +11 -9
  182. package/dist/StatCardFromData.js +113 -116
  183. package/dist/StatCardFromData.js.map +1 -1
  184. package/dist/StripChart.cjs +1 -1
  185. package/dist/StripChart.cjs.map +1 -1
  186. package/dist/StripChart.d.ts +11 -9
  187. package/dist/StripChart.js +434 -435
  188. package/dist/StripChart.js.map +1 -1
  189. package/dist/ThreeDGlobe.cjs +1 -1
  190. package/dist/ThreeDGlobe.cjs.map +1 -1
  191. package/dist/ThreeDGlobe.d.ts +11 -3
  192. package/dist/ThreeDGlobe.js +143 -143
  193. package/dist/ThreeDGlobe.js.map +1 -1
  194. package/dist/ThresholdColorLegendWithMouseOver.cjs +1 -1
  195. package/dist/ThresholdColorLegendWithMouseOver.js +1 -1
  196. package/dist/{Tooltip-Bj-s__cI.js → Tooltip-3EYDVa3w.js} +2 -2
  197. package/dist/{Tooltip-Bj-s__cI.js.map → Tooltip-3EYDVa3w.js.map} +1 -1
  198. package/dist/{Tooltip-Hr46paWP.cjs → Tooltip-C9F3uYG0.cjs} +2 -2
  199. package/dist/{Tooltip-Hr46paWP.cjs.map → Tooltip-C9F3uYG0.cjs.map} +1 -1
  200. package/dist/TreeMapGraph.cjs +1 -1
  201. package/dist/TreeMapGraph.cjs.map +1 -1
  202. package/dist/TreeMapGraph.d.ts +11 -9
  203. package/dist/TreeMapGraph.js +369 -371
  204. package/dist/TreeMapGraph.js.map +1 -1
  205. package/dist/Types.d.ts +28 -16
  206. package/dist/UnitChart.cjs +1 -1
  207. package/dist/UnitChart.cjs.map +1 -1
  208. package/dist/UnitChart.d.ts +11 -5
  209. package/dist/UnitChart.js +118 -119
  210. package/dist/UnitChart.js.map +1 -1
  211. package/dist/WaterfallChart.cjs +1 -1
  212. package/dist/WaterfallChart.cjs.map +1 -1
  213. package/dist/WaterfallChart.d.ts +11 -9
  214. package/dist/WaterfallChart.js +306 -308
  215. package/dist/WaterfallChart.js.map +1 -1
  216. package/dist/XTicksAndGridLines-B4UhDVyU.cjs +2 -0
  217. package/dist/XTicksAndGridLines-B4UhDVyU.cjs.map +1 -0
  218. package/dist/XTicksAndGridLines-CkYwVshF.js +40 -0
  219. package/dist/XTicksAndGridLines-CkYwVshF.js.map +1 -0
  220. package/dist/YTicksAndGridLines-BbujwxOB.js +40 -0
  221. package/dist/YTicksAndGridLines-BbujwxOB.js.map +1 -0
  222. package/dist/YTicksAndGridLines-sT3zdCs6.cjs +2 -0
  223. package/dist/YTicksAndGridLines-sT3zdCs6.cjs.map +1 -0
  224. package/dist/index-BPyj_6hG.js +375 -0
  225. package/dist/index-BPyj_6hG.js.map +1 -0
  226. package/dist/index-DuLvdHo2.cjs +2 -0
  227. package/dist/index-DuLvdHo2.cjs.map +1 -0
  228. package/dist/index.cjs +1 -1
  229. package/dist/index.d.ts +105 -245
  230. package/dist/index.js +2 -2
  231. package/dist/numberFormattingFunction-BUUV_luR.js +28 -0
  232. package/dist/numberFormattingFunction-BUUV_luR.js.map +1 -0
  233. package/dist/numberFormattingFunction-u2iNHL_c.cjs +2 -0
  234. package/dist/numberFormattingFunction-u2iNHL_c.cjs.map +1 -0
  235. package/dist/{string2HTML-ZoGd08P_.cjs → string2HTML-30nfIm8R.cjs} +2 -2
  236. package/dist/{string2HTML-ZoGd08P_.cjs.map → string2HTML-30nfIm8R.cjs.map} +1 -1
  237. package/dist/{string2HTML-BrFperRM.js → string2HTML-DL-pInUB.js} +2 -2
  238. package/dist/{string2HTML-BrFperRM.js.map → string2HTML-DL-pInUB.js.map} +1 -1
  239. package/dist/utils.cjs +1 -1
  240. package/dist/utils.d.ts +1 -1
  241. package/dist/utils.js +1 -1
  242. package/package.json +2 -2
  243. package/dist/GraphEl-B73N4RIA.js +0 -1906
  244. package/dist/GraphEl-B73N4RIA.js.map +0 -1
  245. package/dist/GraphEl-Lt1og0C-.cjs +0 -2
  246. package/dist/GraphEl-Lt1og0C-.cjs.map +0 -1
  247. package/dist/XTicksAndGridLines-C5DuC5oY.cjs +0 -2
  248. package/dist/XTicksAndGridLines-C5DuC5oY.cjs.map +0 -1
  249. package/dist/XTicksAndGridLines-gdbGX2rm.js +0 -39
  250. package/dist/XTicksAndGridLines-gdbGX2rm.js.map +0 -1
  251. package/dist/YTicksAndGridLines-CsNSq9W9.js +0 -39
  252. package/dist/YTicksAndGridLines-CsNSq9W9.js.map +0 -1
  253. package/dist/YTicksAndGridLines-DFjm8RCc.cjs +0 -2
  254. package/dist/YTicksAndGridLines-DFjm8RCc.cjs.map +0 -1
  255. package/dist/index-B0Awa_de.js +0 -377
  256. package/dist/index-B0Awa_de.js.map +0 -1
  257. package/dist/index-CP8cmNzt.cjs +0 -2
  258. package/dist/index-CP8cmNzt.cjs.map +0 -1
  259. package/dist/numberFormattingFunction-Cn9R7CM9.cjs +0 -2
  260. package/dist/numberFormattingFunction-Cn9R7CM9.cjs.map +0 -1
  261. package/dist/numberFormattingFunction-DqMf_v1m.js +0 -28
  262. package/dist/numberFormattingFunction-DqMf_v1m.js.map +0 -1
package/dist/index.d.ts CHANGED
@@ -660,6 +660,9 @@ declare interface DataTableColumnDataType {
660
660
  align?: 'left' | 'right' | 'center';
661
661
  suffix?: string;
662
662
  prefix?: string;
663
+ locale?: string;
664
+ precision?: number;
665
+ padZeros?: boolean;
663
666
  columnWidth?: number;
664
667
  }
665
668
 
@@ -984,8 +987,6 @@ declare interface GraphSettingsDataType {
984
987
  footNote?: string | React.ReactNode;
985
988
  height?: number;
986
989
  width?: number;
987
- suffix?: string;
988
- prefix?: string;
989
990
  sources?: SourcesDataType[];
990
991
  barPadding?: number;
991
992
  showTicks?: boolean;
@@ -1015,7 +1016,14 @@ declare interface GraphSettingsDataType {
1015
1016
  barColors?: [string, string];
1016
1017
  centerGap?: number;
1017
1018
  columnData?: DataTableColumnDataType[];
1018
- mainText?: string;
1019
+ mainText?: string | {
1020
+ label: string;
1021
+ suffix?: string;
1022
+ prefix?: string;
1023
+ locale?: string;
1024
+ padZeros?: boolean;
1025
+ precision?: number;
1026
+ } | ReactElement;
1019
1027
  subNote?: string;
1020
1028
  radius?: number;
1021
1029
  strokeWidth?: number;
@@ -1171,16 +1179,6 @@ declare interface GraphSettingsDataType {
1171
1179
  colorLegendColors?: string[];
1172
1180
  colorLegendDomain?: string[];
1173
1181
  barAxisTitle?: string;
1174
- barSuffix?: string;
1175
- barPrefix?: string;
1176
- lineSuffix?: string;
1177
- linePrefix?: string;
1178
- xSuffix?: string;
1179
- xPrefix?: string;
1180
- ySuffix?: string;
1181
- yPrefix?: string;
1182
- lineSuffixes?: [string, string];
1183
- linePrefixes?: [string, string];
1184
1182
  allowDataDownloadOnDetail?: string | boolean;
1185
1183
  noOfItemsInAPage?: number;
1186
1184
  curveType?: CurveTypes;
@@ -1200,7 +1198,6 @@ declare interface GraphSettingsDataType {
1200
1198
  measureBarWidthFactor?: number;
1201
1199
  mapLegend?: string | React.ReactNode | MapLegendDataType[];
1202
1200
  dimmedOpacity?: number;
1203
- precision?: number;
1204
1201
  customLayers?: CustomLayerDataType[];
1205
1202
  dashedLines?: (string | number)[];
1206
1203
  dashSettings?: string[];
@@ -1237,7 +1234,13 @@ declare interface GraphSettingsDataType {
1237
1234
  showVoronoiTesselation?: boolean;
1238
1235
  mapOverlay?: MapOverlayDataType;
1239
1236
  useVoronoiInteraction?: boolean;
1240
- locale?: string;
1237
+ numberDisplayOptions?: NumberFormatOptions;
1238
+ leftLineNumberDisplayOptions?: NumberFormatOptions;
1239
+ rightLineNumberDisplayOptions?: NumberFormatOptions;
1240
+ barNumberDisplayOptions?: NumberFormatOptions;
1241
+ lineNumberDisplayOptions?: NumberFormatOptions;
1242
+ xNumberDisplayOptions?: NumberFormatOptions;
1243
+ yNumberDisplayOptions?: NumberFormatOptions;
1241
1244
  }
1242
1245
 
1243
1246
  export declare function GraphTitle(props: Props_68): JSX.Element | null;
@@ -1301,10 +1304,6 @@ declare interface GroupedBarChartProps {
1301
1304
  barPadding?: number;
1302
1305
  /** Maximum thickness of bars */
1303
1306
  maxBarThickness?: number;
1304
- /** Prefix for values */
1305
- prefix?: string;
1306
- /** Suffix for values */
1307
- suffix?: string;
1308
1307
  /** Maximum value for the chart */
1309
1308
  maxValue?: number;
1310
1309
  /** Minimum value for the chart */
@@ -1339,10 +1338,8 @@ declare interface GroupedBarChartProps {
1339
1338
  barAxisTitle?: string;
1340
1339
  /** Defines how “NA” values should be displayed/labelled in the graph */
1341
1340
  naLabel?: string;
1342
- /** Specifies the number of decimal places to display in the value. */
1343
- precision?: number;
1344
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
1345
- locale?: string;
1341
+ /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
1342
+ numberDisplayOptions?: NumberFormatOptions;
1346
1343
  /** Optional SVG <g> element or function that renders custom content behind or in front of the graph. */
1347
1344
  customLayers?: CustomLayerDataType[];
1348
1345
  /** Configures playback and slider controls for animating the chart over time. The data must have a key date for it to work properly. */
@@ -1458,7 +1455,7 @@ declare interface InfoBoxDataType {
1458
1455
  description?: string | React.ReactNode;
1459
1456
  }
1460
1457
 
1461
- declare type Languages = 'en' | 'ar' | 'az' | 'bn' | 'cy' | 'he' | 'hi' | 'jp' | 'ka' | 'km' | 'ko' | 'my' | 'ne' | 'zh' | 'custom';
1458
+ declare type Languages = 'en' | 'ar' | 'az' | 'bn' | 'cy' | 'he' | 'hi' | 'ja' | 'ka' | 'km' | 'ko' | 'my' | 'ne' | 'zh' | 'custom';
1462
1459
 
1463
1460
  declare type LightConfig = AmbientLightConfig | DirectionalLightConfig | PointLightConfig | SpotLightConfig;
1464
1461
 
@@ -1519,6 +1516,14 @@ declare interface MultiLineChartDataType {
1519
1516
  data?: object;
1520
1517
  }
1521
1518
 
1519
+ declare interface NumberFormatOptions {
1520
+ locale?: string;
1521
+ precision?: number;
1522
+ prefix?: string;
1523
+ suffix?: string;
1524
+ padZeros?: boolean;
1525
+ }
1526
+
1522
1527
  /**
1523
1528
  * Formats a number into a human-readable string, optionally with prefix/suffix
1524
1529
  * and locale-aware formatting.
@@ -1529,7 +1534,7 @@ declare interface MultiLineChartDataType {
1529
1534
  * - Prefix and suffix
1530
1535
  * - NA fallback
1531
1536
  */
1532
- export declare function numberFormattingFunction(value: number | string | undefined | null, naLabel?: string, precision?: number, prefix?: string, suffix?: string, locale?: string): string;
1537
+ export declare function numberFormattingFunction(value: number | string | undefined | null, naLabel?: string, precision?: number, prefix?: string, suffix?: string, locale?: string, padZeros?: boolean): string;
1533
1538
 
1534
1539
  /**
1535
1540
  * Represents a parameter to be embedded in a URL.
@@ -1642,10 +1647,6 @@ declare interface Props {
1642
1647
  minBarThickness?: number;
1643
1648
  /** Maximum number of bars shown in the graph */
1644
1649
  maxNumberOfBars?: number;
1645
- /** Prefix for values */
1646
- prefix?: string;
1647
- /** Suffix for values */
1648
- suffix?: string;
1649
1650
  /** Maximum value for the chart */
1650
1651
  maxValue?: number;
1651
1652
  /** Minimum value for the chart */
@@ -1684,12 +1685,10 @@ declare interface Props {
1684
1685
  trackColor?: string;
1685
1686
  /** Toggles if data point which are undefined or has value null are filtered out. */
1686
1687
  filterNA?: boolean;
1688
+ /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
1689
+ numberDisplayOptions?: NumberFormatOptions;
1687
1690
  /** Toggles if the graph animates in when loaded. */
1688
1691
  animate?: boolean | AnimateDataType;
1689
- /** Specifies the number of decimal places to display in the value. */
1690
- precision?: number;
1691
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
1692
- locale?: string;
1693
1692
  /** Optional SVG <g> element or function that renders custom content behind or in front of the graph. */
1694
1693
  customLayers?: CustomLayerDataType[];
1695
1694
  /** Configures playback and slider controls for animating the chart over time. The data must have a key date for it to work properly. */
@@ -1761,10 +1760,6 @@ declare interface Props_10 {
1761
1760
  topMargin?: number;
1762
1761
  /** Bottom margin of the graph */
1763
1762
  bottomMargin?: number;
1764
- /** Prefix for values */
1765
- prefix?: string;
1766
- /** Suffix for values */
1767
- suffix?: string;
1768
1763
  /** Maximum value for the chart */
1769
1764
  maxValue?: number;
1770
1765
  /** Minimum value for the chart */
@@ -1811,10 +1806,8 @@ declare interface Props_10 {
1811
1806
  customHighlightAreaSettings?: CustomHighlightAreaSettingsDataType[];
1812
1807
  /** Curve type for the line */
1813
1808
  curveType?: CurveTypes;
1814
- /** Specifies the number of decimal places to display in the value. */
1815
- precision?: number;
1816
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
1817
- locale?: string;
1809
+ /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
1810
+ numberDisplayOptions?: NumberFormatOptions;
1818
1811
  /** Optional SVG <g> element or function that renders custom content behind or in front of the graph. */
1819
1812
  customLayers?: CustomLayerDataType[];
1820
1813
  /** Enable graph download option as png */
@@ -1878,10 +1871,6 @@ declare interface Props_11 {
1878
1871
  topMargin?: number;
1879
1872
  /** Bottom margin of the graph */
1880
1873
  bottomMargin?: number;
1881
- /** Prefix for values */
1882
- prefix?: string;
1883
- /** Suffix for values */
1884
- suffix?: string;
1885
1874
  /** Maximum value for the chart */
1886
1875
  maxValue?: number;
1887
1876
  /** Minimum value for the chart */
@@ -1918,10 +1907,8 @@ declare interface Props_11 {
1918
1907
  customHighlightAreaSettings?: CustomHighlightAreaSettingsDataType[];
1919
1908
  /** Curve type for the line */
1920
1909
  curveType?: CurveTypes;
1921
- /** Specifies the number of decimal places to display in the value. */
1922
- precision?: number;
1923
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
1924
- locale?: string;
1910
+ /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
1911
+ numberDisplayOptions?: NumberFormatOptions;
1925
1912
  /** Defines how “NA” values should be displayed/labelled in the graph */
1926
1913
  naLabel?: string;
1927
1914
  /** Optional SVG <g> element or function that renders custom content behind or in front of the graph. */
@@ -2096,8 +2083,10 @@ declare interface Props_13 {
2096
2083
  customLayers?: CustomLayerDataType[];
2097
2084
  /** Configures playback and slider controls for animating the chart over time. The data must have a key date for it to work properly. */
2098
2085
  timeline?: TimelineDataType;
2099
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
2100
- locale?: string;
2086
+ /** Configuration options for controlling number formatting, localization, precision, and zero padding. */
2087
+ xNumberDisplayOptions?: Omit<NumberFormatOptions, 'suffix' | 'prefix'>;
2088
+ /** Configuration options for controlling number formatting, localization, precision, and zero padding. */
2089
+ yNumberDisplayOptions?: Omit<NumberFormatOptions, 'suffix' | 'prefix'>;
2101
2090
  /** Enable graph download option as png */
2102
2091
  graphDownload?: boolean;
2103
2092
  /** Enable data download option as a csv */
@@ -2205,8 +2194,8 @@ declare interface Props_14 {
2205
2194
  customLayers?: CustomLayerDataType[];
2206
2195
  /** Configures playback and slider controls for animating the chart over time. The data must have a key date for it to work properly. */
2207
2196
  timeline?: TimelineDataType;
2208
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
2209
- locale?: string;
2197
+ /** Configuration options for controlling number formatting, localization, precision, and zero padding. */
2198
+ numberDisplayOptions?: Omit<NumberFormatOptions, 'suffix' | 'prefix'>;
2210
2199
  /** Enable graph download option as png */
2211
2200
  graphDownload?: boolean;
2212
2201
  /** Enable data download option as a csv */
@@ -2435,8 +2424,8 @@ declare interface Props_16 {
2435
2424
  mapProperty?: string;
2436
2425
  /** Configures playback and slider controls for animating the chart over time. The data must have a key date for it to work properly. */
2437
2426
  timeline?: TimelineDataType;
2438
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
2439
- locale?: string;
2427
+ /** Configuration options for controlling number formatting, localization, precision, and zero padding. */
2428
+ numberDisplayOptions?: Omit<NumberFormatOptions, 'suffix' | 'prefix'>;
2440
2429
  /** Enable graph download option as png */
2441
2430
  graphDownload?: boolean;
2442
2431
  /** Enable data download option as a csv */
@@ -2522,8 +2511,8 @@ declare interface Props_17 {
2522
2511
  scaleType?: Exclude<ScaleDataType, 'linear'>;
2523
2512
  /** Toggle visibility of color scale. */
2524
2513
  showColorScale?: boolean;
2525
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
2526
- locale?: string;
2514
+ /** Configuration options for controlling number formatting, localization, precision, and zero padding. */
2515
+ numberDisplayOptions?: Omit<NumberFormatOptions, 'suffix' | 'prefix'>;
2527
2516
  /** Toggle if color scale is collapsed by default. */
2528
2517
  collapseColorScaleByDefault?: boolean;
2529
2518
  /** The max altitude of the atmosphere, in terms of globe radius units. */
@@ -2700,10 +2689,6 @@ declare interface Props_2 {
2700
2689
  topMargin?: number;
2701
2690
  /** Bottom margin of the graph */
2702
2691
  bottomMargin?: number;
2703
- /** Prefix for values */
2704
- prefix?: string;
2705
- /** Suffix for values */
2706
- suffix?: string;
2707
2692
  /** Maximum value mapped to the radius chart */
2708
2693
  maxRadiusValue?: number;
2709
2694
  /** If true, the graph will be rendered in a circle layout */
@@ -2722,10 +2707,8 @@ declare interface Props_2 {
2722
2707
  highlightedDataPoints?: (string | number)[];
2723
2708
  /** Defines the opacity of the non-highlighted data */
2724
2709
  dimmedOpacity?: number;
2725
- /** Specifies the number of decimal places to display in the value. */
2726
- precision?: number;
2727
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
2728
- locale?: string;
2710
+ /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
2711
+ numberDisplayOptions?: NumberFormatOptions;
2729
2712
  /** Enable graph download option as png */
2730
2713
  graphDownload?: boolean;
2731
2714
  /** Enable data download option as a csv */
@@ -2843,14 +2826,6 @@ declare interface Props_21 {
2843
2826
  topMargin?: number;
2844
2827
  /** Bottom margin of the graph */
2845
2828
  bottomMargin?: number;
2846
- /** Prefix for values on x-axis */
2847
- xPrefix?: string;
2848
- /** Suffix for values on x-axis */
2849
- xSuffix?: string;
2850
- /** Prefix for values on y-axis */
2851
- yPrefix?: string;
2852
- /** Suffix for values on y-axis */
2853
- ySuffix?: string;
2854
2829
  /** Maximum value for the x-axis */
2855
2830
  maxXValue?: number;
2856
2831
  /** Minimum value for the x-axis */
@@ -2899,10 +2874,10 @@ declare interface Props_21 {
2899
2874
  labelColor?: string;
2900
2875
  /** Toggles if the graph animates in when loaded. */
2901
2876
  animate?: boolean | AnimateDataType;
2902
- /** Specifies the number of decimal places to display in the value. */
2903
- precision?: number;
2904
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
2905
- locale?: string;
2877
+ /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
2878
+ xNumberDisplayOptions?: NumberFormatOptions;
2879
+ /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
2880
+ yNumberDisplayOptions?: NumberFormatOptions;
2906
2881
  /** Optional SVG <g> element or function that renders custom content behind or in front of the graph. */
2907
2882
  customLayers?: CustomLayerDataType[];
2908
2883
  /** Configures playback and slider controls for animating the chart over time. The data must have a key date for it to work properly. */
@@ -3113,6 +3088,8 @@ declare interface Props_23 {
3113
3088
  hideAxisLine?: boolean;
3114
3089
  /** Toggle visibility of color scale. This is only applicable if the data props hae color parameter */
3115
3090
  showColorScale?: boolean;
3091
+ /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
3092
+ numberDisplayOptions?: Omit<NumberFormatOptions, 'suffix' | 'prefix'>;
3116
3093
  /** Data points to highlight. Use the label value from data to highlight the data point */
3117
3094
  highlightedDataPoints?: (string | number)[];
3118
3095
  /** Defines the opacity of the non-highlighted data */
@@ -3129,10 +3106,6 @@ declare interface Props_23 {
3129
3106
  animate?: boolean | AnimateDataType;
3130
3107
  /** Configures playback and slider controls for animating the chart over time. The data must have a key date for it to work properly. */
3131
3108
  timeline?: TimelineDataType;
3132
- /** Specifies the number of decimal places to display in the value. */
3133
- precision?: number;
3134
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
3135
- locale?: string;
3136
3109
  /** Optional SVG <g> element or function that renders custom content behind or in front of the graph. */
3137
3110
  customLayers?: CustomLayerDataType[];
3138
3111
  /** Enable graph download option as png */
@@ -3200,10 +3173,6 @@ declare interface Props_24 {
3200
3173
  topMargin?: number;
3201
3174
  /** Bottom margin of the graph */
3202
3175
  bottomMargin?: number;
3203
- /** Prefix for values */
3204
- prefix?: string;
3205
- /** Suffix for values */
3206
- suffix?: string;
3207
3176
  /** Maximum value for the chart */
3208
3177
  maxValue?: number;
3209
3178
  /** Minimum value for the chart */
@@ -3228,10 +3197,8 @@ declare interface Props_24 {
3228
3197
  customHighlightAreaSettings?: CustomHighlightAreaSettingsDataType[];
3229
3198
  /** Curve type for the line */
3230
3199
  curveType?: CurveTypes;
3231
- /** Specifies the number of decimal places to display in the value. */
3232
- precision?: number;
3233
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
3234
- locale?: string;
3200
+ /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
3201
+ numberDisplayOptions?: NumberFormatOptions;
3235
3202
  /** Optional SVG <g> element or function that renders custom content behind or in front of the graph. */
3236
3203
  customLayers?: CustomLayerDataType[];
3237
3204
  /** Toggles if the graph animates in when loaded. */
@@ -3281,18 +3248,14 @@ declare interface Props_25 {
3281
3248
  styles?: StyleObject;
3282
3249
  /** Custom class names */
3283
3250
  classNames?: ClassNameObject;
3284
- /** Prefix for values */
3285
- prefix?: string;
3286
- /** Suffix for values */
3287
- suffix?: string;
3288
- /** Specifies the number of decimal places to display in the value. */
3289
- precision?: number;
3251
+ /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
3252
+ numberDisplayOptions?: NumberFormatOptions;
3253
+ /** Defines how “NA” values should be displayed/labelled in the graph */
3254
+ naLabel?: string;
3290
3255
  /** Main text */
3291
3256
  value: number | string;
3292
3257
  /** Sub text next to main text */
3293
3258
  year?: number | string;
3294
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
3295
- locale?: string;
3296
3259
  /** Language setting */
3297
3260
  language?: Languages;
3298
3261
  /** Color theme */
@@ -3332,22 +3295,16 @@ declare interface Props_26 {
3332
3295
  styles?: StyleObject;
3333
3296
  /** Custom class names */
3334
3297
  classNames?: ClassNameObject;
3335
- /** Prefix for values */
3336
- prefix?: string;
3337
- /** Suffix for values */
3338
- suffix?: string;
3339
3298
  /** Sub text next to main text */
3340
3299
  year?: number | string;
3341
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
3342
- locale?: string;
3300
+ /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
3301
+ numberDisplayOptions?: NumberFormatOptions;
3343
3302
  /** Defines how “NA” values should be displayed/labelled in the graph */
3344
3303
  naLabel?: string;
3345
3304
  /** Data points that need to counted for aggregation. */
3346
3305
  countOnly?: (string | number)[];
3347
3306
  /** Method for aggregating the data to show as a single number in the card. If the data type of value in data object is string then only count is applicable. */
3348
3307
  aggregationMethod?: 'count' | 'max' | 'min' | 'average' | 'sum';
3349
- /** Specifies the number of decimal places to display in the value. */
3350
- precision?: number;
3351
3308
  /** Language setting */
3352
3309
  language?: Languages;
3353
3310
  /** Color theme */
@@ -3400,10 +3357,6 @@ declare interface Props_27 {
3400
3357
  /** Bottom margin of the graph */
3401
3358
  bottomMargin?: number;
3402
3359
  /** Maximum radius of the circle */
3403
- /** Prefix for values */
3404
- prefix?: string;
3405
- /** Suffix for values */
3406
- suffix?: string;
3407
3360
  /** Toggle visibility of labels */
3408
3361
  showLabels?: boolean;
3409
3362
  /** Toggle visibility of values */
@@ -3418,10 +3371,8 @@ declare interface Props_27 {
3418
3371
  dimmedOpacity?: number;
3419
3372
  /** Toggles if the graph animates in when loaded. */
3420
3373
  animate?: boolean | AnimateDataType;
3421
- /** Specifies the number of decimal places to display in the value. */
3422
- precision?: number;
3423
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
3424
- locale?: string;
3374
+ /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
3375
+ numberDisplayOptions?: NumberFormatOptions;
3425
3376
  /** Enable graph download option as png */
3426
3377
  graphDownload?: boolean;
3427
3378
  /** Enable data download option as a csv */
@@ -3491,16 +3442,14 @@ declare interface Props_28 {
3491
3442
  animate?: boolean | AnimateDataType;
3492
3443
  /** Toggle visibility of color scale */
3493
3444
  showColorScale?: boolean;
3494
- /** Specifies the number of decimal places to display in the value. */
3495
- precision?: number;
3445
+ /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
3446
+ numberDisplayOptions?: NumberFormatOptions;
3496
3447
  /** Defines how “NA” values should be displayed/labelled in the graph */
3497
3448
  naLabel?: string;
3498
3449
  /** Enable graph download option as png */
3499
3450
  graphDownload?: boolean;
3500
3451
  /** Enable data download option as a csv */
3501
3452
  dataDownload?: boolean;
3502
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
3503
- locale?: string;
3504
3453
  /** Language setting */
3505
3454
  language?: Languages;
3506
3455
  /** Color theme */
@@ -3554,10 +3503,6 @@ declare interface Props_29 {
3554
3503
  bottomMargin?: number;
3555
3504
  /** Toggles the background to fill the container. This only works if the width of the graph is defined. */
3556
3505
  fillContainer?: boolean;
3557
- /** Prefix for values */
3558
- prefix?: string;
3559
- /** Suffix for values */
3560
- suffix?: string;
3561
3506
  /** Maximum value for the chart */
3562
3507
  truncateBy?: number;
3563
3508
  /** Reference values for comparison */
@@ -3577,10 +3522,8 @@ declare interface Props_29 {
3577
3522
  animate?: boolean | AnimateDataType;
3578
3523
  /** Domain for the colors in the cell. */
3579
3524
  colorDomain: number[] | string[];
3580
- /** Specifies the number of decimal places to display in the value. */
3581
- precision?: number;
3582
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
3583
- locale?: string;
3525
+ /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
3526
+ numberDisplayOptions?: NumberFormatOptions;
3584
3527
  /** Defines how “NA” values should be displayed/labelled in the graph */
3585
3528
  naLabel?: string;
3586
3529
  /** Enable graph download option as png */
@@ -3640,10 +3583,6 @@ declare interface Props_3 {
3640
3583
  padding?: string;
3641
3584
  /** Radius of the donut chart */
3642
3585
  radius?: number;
3643
- /** Prefix for values */
3644
- prefix?: string;
3645
- /** Suffix for values */
3646
- suffix?: string;
3647
3586
  /** Toggle visibility of color scale. This is only applicable if the data props hae color parameter */
3648
3587
  showColorScale?: boolean;
3649
3588
  /** Max width of the color scale as a css property */
@@ -3659,11 +3598,12 @@ declare interface Props_3 {
3659
3598
  label: string;
3660
3599
  suffix?: string;
3661
3600
  prefix?: string;
3601
+ locale?: string;
3602
+ padZeros?: boolean;
3603
+ precision?: number;
3662
3604
  } | ReactElement;
3663
3605
  /** Small text at the center of the donut chart */
3664
3606
  subNote?: string;
3665
- /** Specifies the number of decimal places to display in the value. */
3666
- precision?: number;
3667
3607
  /** Track color (i.e. the color of the donut chart's background) of the donut chart */
3668
3608
  trackColor?: string;
3669
3609
  /** Enable graph download option as png */
@@ -3672,8 +3612,8 @@ declare interface Props_3 {
3672
3612
  dataDownload?: boolean;
3673
3613
  /** Reset selection on double-click. Only applicable when used in a dashboard context with filters. */
3674
3614
  resetSelectionOnDoubleClick?: boolean;
3675
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
3676
- locale?: string;
3615
+ /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
3616
+ numberDisplayOptions?: NumberFormatOptions;
3677
3617
  /** Defines how “NA” values should be displayed/labelled in the graph */
3678
3618
  naLabel?: string;
3679
3619
  /** Tooltip content. If the type is string then this uses the [handlebar](../?path=/docs/misc-handlebars-templates-and-custom-helpers--docs) template to display the data */
@@ -3721,8 +3661,6 @@ declare interface Props_30 {
3721
3661
  padding?: string;
3722
3662
  /** Column settings for each column shown in the table. */
3723
3663
  columnData: DataTableColumnDataType[];
3724
- /** Specifies the number of decimal places to display in the value. */
3725
- precision?: number;
3726
3664
  /** Defines how “NA” values should be displayed/labelled in the graph */
3727
3665
  naLabel?: string;
3728
3666
  /** Reset selection on double-click. Only applicable when used in a dashboard context with filters. */
@@ -3735,8 +3673,6 @@ declare interface Props_30 {
3735
3673
  theme?: 'light' | 'dark';
3736
3674
  /** Unique ID for the graph */
3737
3675
  graphID?: string;
3738
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
3739
- locale?: string;
3740
3676
  }
3741
3677
 
3742
3678
  declare interface Props_31 {
@@ -3851,10 +3787,6 @@ declare interface Props_32 {
3851
3787
  topMargin?: number;
3852
3788
  /** Bottom margin of the graph */
3853
3789
  bottomMargin?: number;
3854
- /** Prefix for values */
3855
- prefix?: string;
3856
- /** Suffix for values */
3857
- suffix?: string;
3858
3790
  /** Maximum value for the chart */
3859
3791
  maxValue?: number;
3860
3792
  /** Minimum value for the chart */
@@ -3879,10 +3811,8 @@ declare interface Props_32 {
3879
3811
  animate?: boolean | AnimateDataType;
3880
3812
  /** Toggles if the graph show the min and max value of the data. */
3881
3813
  showDataMinMax?: boolean;
3882
- /** Specifies the number of decimal places to display in the value. */
3883
- precision?: number;
3884
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
3885
- locale?: string;
3814
+ /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
3815
+ numberDisplayOptions?: NumberFormatOptions;
3886
3816
  /** Optional SVG <g> element or function that renders custom content behind or in front of the graph. */
3887
3817
  customLayers?: CustomLayerDataType[];
3888
3818
  /** Enable graph download option as png */
@@ -3952,14 +3882,6 @@ declare interface Props_33 {
3952
3882
  bottomMargin?: number;
3953
3883
  /** Padding between bars */
3954
3884
  barPadding?: number;
3955
- /** Suffix for values of the lines */
3956
- lineSuffix?: string;
3957
- /** Suffix for values of the bars */
3958
- barSuffix?: string;
3959
- /** Prefix for values of the lines */
3960
- linePrefix?: string;
3961
- /** Prefix for values of the bars */
3962
- barPrefix?: string;
3963
3885
  /** Truncate labels by specified length */
3964
3886
  truncateBy?: number;
3965
3887
  /** Number of ticks on the axis */
@@ -3984,10 +3906,10 @@ declare interface Props_33 {
3984
3906
  naLabel?: string;
3985
3907
  /** Toggles if the graph animates in when loaded. */
3986
3908
  animate?: boolean | AnimateDataType;
3987
- /** Specifies the number of decimal places to display in the value. */
3988
- precision?: number;
3989
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
3990
- locale?: string;
3909
+ /** Configuration options for lines controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
3910
+ lineNumberDisplayOptions?: NumberFormatOptions;
3911
+ /** Configuration options for bars controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
3912
+ barNumberDisplayOptions?: NumberFormatOptions;
3991
3913
  /** Optional SVG <g> element or function that renders custom content behind or in front of the graph. */
3992
3914
  customLayers?: CustomLayerDataType[];
3993
3915
  /** Enable graph download option as png */
@@ -4057,10 +3979,6 @@ declare interface Props_34 {
4057
3979
  barPadding?: number;
4058
3980
  /** Spacing between the left and right bars */
4059
3981
  centerGap?: number;
4060
- /** Prefix for values */
4061
- prefix?: string;
4062
- /** Suffix for values */
4063
- suffix?: string;
4064
3982
  /** Maximum value for the chart */
4065
3983
  maxValue?: number;
4066
3984
  /** Minimum value for the chart */
@@ -4087,10 +4005,8 @@ declare interface Props_34 {
4087
4005
  naLabel?: string;
4088
4006
  /** Toggles if the graph animates in when loaded. */
4089
4007
  animate?: boolean | AnimateDataType;
4090
- /** Specifies the number of decimal places to display in the value. */
4091
- precision?: number;
4092
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
4093
- locale?: string;
4008
+ /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
4009
+ numberDisplayOptions?: NumberFormatOptions;
4094
4010
  /** Optional SVG <g> element or function that renders custom content behind or in front of the graph. */
4095
4011
  customLayers?: CustomLayerDataType[];
4096
4012
  /** Configures playback and slider controls for animating the chart over time. The data must have a key date for it to work properly. */
@@ -4184,10 +4100,8 @@ declare interface Props_35 {
4184
4100
  showTicks?: boolean;
4185
4101
  /** Toggle visibility of axis line for the main axis. Only applicable if `graphType` is `barGraph`. */
4186
4102
  hideAxisLine?: boolean;
4187
- /** Specifies the number of decimal places to display in the value. */
4188
- precision?: number;
4189
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
4190
- locale?: string;
4103
+ /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
4104
+ numberDisplayOptions?: NumberFormatOptions;
4191
4105
  /** Enable graph download option as png */
4192
4106
  graphDownload?: boolean;
4193
4107
  /** Enable data download option as a csv */
@@ -4259,10 +4173,6 @@ declare interface Props_36 {
4259
4173
  minBarThickness?: number;
4260
4174
  /** Maximum number of bars shown in the graph */
4261
4175
  maxNumberOfBars?: number;
4262
- /** Prefix for values */
4263
- prefix?: string;
4264
- /** Suffix for values */
4265
- suffix?: string;
4266
4176
  /** Maximum value for the chart */
4267
4177
  maxValue?: number;
4268
4178
  /** Minimum value for the chart */
@@ -4299,10 +4209,8 @@ declare interface Props_36 {
4299
4209
  filterNA?: boolean;
4300
4210
  /** Toggles if the graph animates in when loaded. */
4301
4211
  animate?: boolean | AnimateDataType;
4302
- /** Specifies the number of decimal places to display in the value. */
4303
- precision?: number;
4304
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
4305
- locale?: string;
4212
+ /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
4213
+ numberDisplayOptions?: NumberFormatOptions;
4306
4214
  /** Optional SVG <g> element or function that renders custom content behind or in front of the graph. */
4307
4215
  customLayers?: CustomLayerDataType[];
4308
4216
  /** Enable graph download option as png */
@@ -4376,10 +4284,6 @@ declare interface Props_37 {
4376
4284
  nodePadding?: number;
4377
4285
  /** Thickness of each node */
4378
4286
  nodeWidth?: number;
4379
- /** Prefix for values */
4380
- prefix?: string;
4381
- /** Suffix for values */
4382
- suffix?: string;
4383
4287
  /** Truncate labels by specified length */
4384
4288
  truncateBy?: number;
4385
4289
  /** Title of the source */
@@ -4400,10 +4304,8 @@ declare interface Props_37 {
4400
4304
  sortNodes?: 'asc' | 'desc' | 'mostReadable' | 'none';
4401
4305
  /** Toggles if the graph animates in when loaded. */
4402
4306
  animate?: boolean | AnimateDataType;
4403
- /** Specifies the number of decimal places to display in the value. */
4404
- precision?: number;
4405
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
4406
- locale?: string;
4307
+ /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
4308
+ numberDisplayOptions?: NumberFormatOptions;
4407
4309
  /** Optional SVG <g> element or function that renders custom content behind or in front of the graph. */
4408
4310
  customLayers?: CustomLayerDataType[];
4409
4311
  /** Enable graph download option as png */
@@ -4503,10 +4405,8 @@ declare interface Props_38 {
4503
4405
  curveType?: 'linear' | 'curve';
4504
4406
  /** Reset selection on double-click. Only applicable when used in a dashboard context with filters. */
4505
4407
  resetSelectionOnDoubleClick?: boolean;
4506
- /** Specifies the number of decimal places to display in the value. */
4507
- precision?: number;
4508
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
4509
- locale?: string;
4408
+ /** Configuration options for controlling number formatting, localization, precision, and zero padding. */
4409
+ numberDisplayOptions?: Omit<NumberFormatOptions, 'suffix' | 'prefix'>;
4510
4410
  /** Optional SVG <g> element or function that renders custom content behind or in front of the graph. */
4511
4411
  customLayers?: CustomLayerDataType[];
4512
4412
  /** Enable graph download option as png */
@@ -4605,10 +4505,6 @@ declare interface Props_4 {
4605
4505
  maxNumberOfBars?: number;
4606
4506
  /** Radius of the dots */
4607
4507
  radius?: number;
4608
- /** Prefix for values */
4609
- prefix?: string;
4610
- /** Suffix for values */
4611
- suffix?: string;
4612
4508
  /** Maximum value for the chart */
4613
4509
  maxValue?: number;
4614
4510
  /** Minimum value for the chart */
@@ -4649,10 +4545,8 @@ declare interface Props_4 {
4649
4545
  filterNA?: boolean;
4650
4546
  /** Toggles if the graph animates in when loaded. */
4651
4547
  animate?: boolean | AnimateDataType;
4652
- /** Specifies the number of decimal places to display in the value. */
4653
- precision?: number;
4654
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
4655
- locale?: string;
4548
+ /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
4549
+ numberDisplayOptions?: NumberFormatOptions;
4656
4550
  /** Optional SVG <g> element or function that renders custom content behind or in front of the graph. */
4657
4551
  customLayers?: CustomLayerDataType[];
4658
4552
  /** Configures playback and slider controls for animating the chart over time. The data must have a key date for it to work properly. */
@@ -4880,10 +4774,6 @@ declare interface Props_5 {
4880
4774
  topMargin?: number;
4881
4775
  /** Bottom margin of the graph */
4882
4776
  bottomMargin?: number;
4883
- /** Prefix for values */
4884
- prefix?: string;
4885
- /** Suffix for values */
4886
- suffix?: string;
4887
4777
  /** Maximum value for the radius of the circle */
4888
4778
  maxRadiusValue?: number;
4889
4779
  /** Minimum value for position of the circle */
@@ -4910,10 +4800,8 @@ declare interface Props_5 {
4910
4800
  dimmedOpacity?: number;
4911
4801
  /** Maximum radius of the circles */
4912
4802
  radius?: number;
4913
- /** Specifies the number of decimal places to display in the value. */
4914
- precision?: number;
4915
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
4916
- locale?: string;
4803
+ /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
4804
+ numberDisplayOptions?: NumberFormatOptions;
4917
4805
  /** Optional SVG <g> element or function that renders custom content behind or in front of the graph. */
4918
4806
  customLayers?: CustomLayerDataType[];
4919
4807
  /** Enable graph download option as png */
@@ -5048,10 +4936,6 @@ declare interface Props_6 {
5048
4936
  topMargin?: number;
5049
4937
  /** Bottom margin of the graph */
5050
4938
  bottomMargin?: number;
5051
- /** Prefix for values of the lines */
5052
- linePrefixes?: [string, string];
5053
- /** Suffix for values of the lines */
5054
- lineSuffixes?: [string, string];
5055
4939
  /** Maximum value of the date for the chart */
5056
4940
  maxDate?: string | number;
5057
4941
  /** Minimum value of the date for the chart */
@@ -5082,10 +4966,10 @@ declare interface Props_6 {
5082
4966
  highlightAreaSettings?: HighlightAreaSettingsDataType[];
5083
4967
  /** Curve type for the line */
5084
4968
  curveType?: CurveTypes;
5085
- /** Specifies the number of decimal places to display in the value. */
5086
- precision?: number;
5087
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
5088
- locale?: string;
4969
+ /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding for left line. */
4970
+ leftLineNumberDisplayOptions?: NumberFormatOptions;
4971
+ /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding for right line. */
4972
+ rightLineNumberDisplayOptions?: NumberFormatOptions;
5089
4973
  /** Defines how “NA” values should be displayed/labelled in the graph */
5090
4974
  naLabel?: string;
5091
4975
  /** Optional SVG <g> element or function that renders custom content behind or in front of the graph. */
@@ -5250,10 +5134,6 @@ declare interface Props_7 {
5250
5134
  topMargin?: number;
5251
5135
  /** Bottom margin of the graph */
5252
5136
  bottomMargin?: number;
5253
- /** Prefix for values */
5254
- prefix?: string;
5255
- /** Suffix for values */
5256
- suffix?: string;
5257
5137
  /** Maximum value for the chart */
5258
5138
  maxValue?: number;
5259
5139
  /** Minimum value for the chart */
@@ -5298,10 +5178,8 @@ declare interface Props_7 {
5298
5178
  regressionLine?: boolean | string;
5299
5179
  /** Curve type for the line */
5300
5180
  curveType?: CurveTypes;
5301
- /** Specifies the number of decimal places to display in the value. */
5302
- precision?: number;
5303
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
5304
- locale?: string;
5181
+ /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
5182
+ numberDisplayOptions?: NumberFormatOptions;
5305
5183
  /** Optional SVG <g> element or function that renders custom content behind or in front of the graph. */
5306
5184
  customLayers?: CustomLayerDataType[];
5307
5185
  /** Enable graph download option as png */
@@ -5359,10 +5237,6 @@ declare interface Props_8 {
5359
5237
  topMargin?: number;
5360
5238
  /** Bottom margin of the graph */
5361
5239
  bottomMargin?: number;
5362
- /** Prefix for values */
5363
- prefix?: string;
5364
- /** Suffix for values */
5365
- suffix?: string;
5366
5240
  /** Maximum value for the chart */
5367
5241
  maxValue?: number;
5368
5242
  /** Minimum value for the chart */
@@ -5399,10 +5273,8 @@ declare interface Props_8 {
5399
5273
  regressionLine?: boolean | string;
5400
5274
  /** Curve type for the line */
5401
5275
  curveType?: CurveTypes;
5402
- /** Specifies the number of decimal places to display in the value. */
5403
- precision?: number;
5404
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
5405
- locale?: string;
5276
+ /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
5277
+ numberDisplayOptions?: NumberFormatOptions;
5406
5278
  /** Optional SVG <g> element or function that renders custom content behind or in front of the graph. */
5407
5279
  customLayers?: CustomLayerDataType[];
5408
5280
  /** Enable graph download option as png */
@@ -5470,10 +5342,6 @@ declare interface Props_9 {
5470
5342
  topMargin?: number;
5471
5343
  /** Bottom margin of the graph */
5472
5344
  bottomMargin?: number;
5473
- /** Prefix for values */
5474
- prefix?: string;
5475
- /** Suffix for values */
5476
- suffix?: string;
5477
5345
  /** Maximum value for the chart */
5478
5346
  maxValue?: number;
5479
5347
  /** Minimum value for the chart */
@@ -5516,10 +5384,8 @@ declare interface Props_9 {
5516
5384
  customHighlightAreaSettings?: CustomHighlightAreaSettingsDataType[];
5517
5385
  /** Curve type for the line */
5518
5386
  curveType?: CurveTypes;
5519
- /** Specifies the number of decimal places to display in the value. */
5520
- precision?: number;
5521
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
5522
- locale?: string;
5387
+ /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
5388
+ numberDisplayOptions?: NumberFormatOptions;
5523
5389
  /** Defines how “NA” values should be displayed/labelled in the graph */
5524
5390
  naLabel?: string;
5525
5391
  /** Optional SVG <g> element or function that renders custom content behind or in front of the graph. */
@@ -5729,10 +5595,6 @@ declare interface StackedBarChartProps {
5729
5595
  minBarThickness?: number;
5730
5596
  /** Maximum number of bars shown in the graph */
5731
5597
  maxNumberOfBars?: number;
5732
- /** Prefix for values */
5733
- prefix?: string;
5734
- /** Suffix for values */
5735
- suffix?: string;
5736
5598
  /** Maximum value for the chart */
5737
5599
  maxValue?: number;
5738
5600
  /** Minimum value for the chart */
@@ -5757,6 +5619,8 @@ declare interface StackedBarChartProps {
5757
5619
  barAxisTitle?: string;
5758
5620
  /** Defines how “NA” values should be displayed/labelled in the graph */
5759
5621
  naLabel?: string;
5622
+ /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
5623
+ numberDisplayOptions?: NumberFormatOptions;
5760
5624
  /** Parameter to sort the data. If a number is provided, it refers to the index of the size array to determine which value to sort by. If set to total, it sorts by the sum of all the values. */
5761
5625
  sortParameter?: number | 'total';
5762
5626
  /** Sorting order for data. This is overwritten by labelOrder prop. */
@@ -5765,10 +5629,6 @@ declare interface StackedBarChartProps {
5765
5629
  filterNA?: boolean;
5766
5630
  /** Toggles if the graph animates in when loaded. */
5767
5631
  animate?: boolean | AnimateDataType;
5768
- /** Specifies the number of decimal places to display in the value. */
5769
- precision?: number;
5770
- /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
5771
- locale?: string;
5772
5632
  /** Optional SVG <g> element or function that renders custom content behind or in front of the graph. */
5773
5633
  customLayers?: CustomLayerDataType[];
5774
5634
  /** Configures playback and slider controls for animating the chart over time. The data must have a key date for it to work properly. */