@undp/data-viz 2.4.1 → 2.5.0

package/dist/BarGraph.d.ts

@@ -103,10 +103,6 @@ declare interface GroupedBarChartProps {
     barPadding?: number;
     /** Maximum thickness of bars */
     maxBarThickness?: number;
-    /** Prefix for values */
-    prefix?: string;
-    /** Suffix for values */
-    suffix?: string;
     /** Maximum value for the chart */
     maxValue?: number;
     /** Minimum value for the chart */
@@ -141,10 +137,8 @@ declare interface GroupedBarChartProps {
     barAxisTitle?: string;
     /** Defines how “NA” values should be displayed/labelled in the graph */
     naLabel?: string;
-    /** Specifies the number of decimal places to display in the value. */
-    precision?: number;
-    /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
-    locale?: string;
+    /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
+    numberDisplayOptions?: NumberFormatOptions;
     /** Optional SVG <g> element or function that renders custom content behind or in front of the graph. */
     customLayers?: CustomLayerDataType[];
     /** Configures playback and slider controls for animating the chart over time. The data must have a key date for it to work properly. */
@@ -180,7 +174,15 @@ declare interface GroupedBarGraphDataType {
     data?: object;
 }
 
-declare type Languages = 'en' | 'ar' | 'az' | 'bn' | 'cy' | 'he' | 'hi' | 'jp' | 'ka' | 'km' | 'ko' | 'my' | 'ne' | 'zh' | 'custom';
+declare type Languages = 'en' | 'ar' | 'az' | 'bn' | 'cy' | 'he' | 'hi' | 'ja' | 'ka' | 'km' | 'ko' | 'my' | 'ne' | 'zh' | 'custom';
+
+declare interface NumberFormatOptions {
+    locale?: string;
+    precision?: number;
+    prefix?: string;
+    suffix?: string;
+    padZeros?: boolean;
+}
 
 declare interface Props {
     /** Array of data objects */
@@ -237,10 +239,6 @@ declare interface Props {
     minBarThickness?: number;
     /** Maximum number of bars shown in the graph */
     maxNumberOfBars?: number;
-    /** Prefix for values */
-    prefix?: string;
-    /** Suffix for values */
-    suffix?: string;
     /** Maximum value for the chart */
     maxValue?: number;
     /** Minimum value for the chart */
@@ -279,12 +277,10 @@ declare interface Props {
     trackColor?: string;
     /** Toggles if data point which are undefined or has value null are filtered out.  */
     filterNA?: boolean;
+    /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
+    numberDisplayOptions?: NumberFormatOptions;
     /** Toggles if the graph animates in when loaded.  */
     animate?: boolean | AnimateDataType;
-    /** Specifies the number of decimal places to display in the value. */
-    precision?: number;
-    /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
-    locale?: string;
     /** Optional SVG <g> element or function that renders custom content behind or in front of the graph. */
     customLayers?: CustomLayerDataType[];
     /** Configures playback and slider controls for animating the chart over time. The data must have a key date for it to work properly. */
@@ -387,10 +383,6 @@ declare interface StackedBarChartProps {
     minBarThickness?: number;
     /** Maximum number of bars shown in the graph */
     maxNumberOfBars?: number;
-    /** Prefix for values */
-    prefix?: string;
-    /** Suffix for values */
-    suffix?: string;
     /** Maximum value for the chart */
     maxValue?: number;
     /** Minimum value for the chart */
@@ -415,6 +407,8 @@ declare interface StackedBarChartProps {
     barAxisTitle?: string;
     /** Defines how “NA” values should be displayed/labelled in the graph */
     naLabel?: string;
+    /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
+    numberDisplayOptions?: NumberFormatOptions;
     /** 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. */
     sortParameter?: number | 'total';
     /** Sorting order for data. This is overwritten by labelOrder prop. */
@@ -423,10 +417,6 @@ declare interface StackedBarChartProps {
     filterNA?: boolean;
     /** Toggles if the graph animates in when loaded.  */
     animate?: boolean | AnimateDataType;
-    /** Specifies the number of decimal places to display in the value. */
-    precision?: number;
-    /** Locale for number formatting. Must matches what `Intl.NumberFormat` expects. */
-    locale?: string;
     /** Optional SVG <g> element or function that renders custom content behind or in front of the graph. */
     customLayers?: CustomLayerDataType[];
     /** Configures playback and slider controls for animating the chart over time. The data must have a key date for it to work properly. */