@undp/data-viz 2.4.1 → 2.5.0

package/dist/BulletChart.d.ts

@@ -55,7 +55,15 @@ declare interface CustomLayerDataType {
     layer: React.ReactNode;
 }
 
-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 */
@@ -148,6 +156,8 @@ declare interface Props {
     hideAxisLine?: boolean;
     /** Toggle visibility of color scale. This is only applicable if the data props hae color parameter */
     showColorScale?: boolean;
+    /** Configuration options for controlling number formatting, localization, prefixes/suffixes, precision, and zero padding. */
+    numberDisplayOptions?: Omit<NumberFormatOptions, 'suffix' | 'prefix'>;
     /** Data points to highlight. Use the label value from data to highlight the data point */
     highlightedDataPoints?: (string | number)[];
     /** Defines the opacity of the non-highlighted data */
@@ -164,10 +174,6 @@ declare interface Props {
     animate?: boolean | AnimateDataType;
     /** Configures playback and slider controls for animating the chart over time. The data must have a key date for it to work properly. */
     timeline?: TimelineDataType;
-    /** 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[];
     /** Enable graph download option as png */