@undp/data-viz 1.2.2 → 1.2.3

package/dist/index.d.ts

@@ -4218,6 +4218,7 @@ declare interface GraphSettingsDataType {
     atmosphereColor?: string;
     lineAxisTitle?: string;
     timeline?: TimelineDataType;
+    naLabel?: string;
 }
 
 export declare function GraphTitle(props: Props_59): JSX.Element | null;
@@ -4311,6 +4312,8 @@ declare interface GroupedBarChartProps {
     showColorScale?: boolean;
     /** Title for the bar axis */
     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;
     /** Optional SVG <g> element or function that renders custom content behind or in front of the graph. */
@@ -4493,7 +4496,7 @@ declare interface MultiLineChartDataType {
  * numberFormattingFunction(3.14159, '$'); // "$3.14"
  * numberFormattingFunction(null); // "NA"
  */
-export declare function numberFormattingFunction(value: number | undefined | null, precision?: number, prefix?: string, suffix?: string): string;
+export declare function numberFormattingFunction(value: number | string | undefined | null, naLabel?: string, precision?: number, prefix?: string, suffix?: string): string;
 
 /**
  * Represents a parameter to be embedded in a URL.
@@ -4587,6 +4590,8 @@ declare interface Props {
     showValues?: boolean;
     /** Custom order for labels */
     labelOrder?: string[];
+    /** Defines how “NA” values should be displayed/labelled in the graph */
+    naLabel?: string;
     /** Toggle visibility of axis ticks */
     showTicks?: boolean;
     /** Toggle visibility of color scale. This is only applicable if the data props hae color parameter */
@@ -4710,6 +4715,8 @@ declare interface Props_10 {
     showColorScale?: boolean;
     /** Toggle visibility of NA color in the color scale. This is only applicable if the data props hae color parameter and showColorScale prop is true */
     showNAColor?: boolean;
+    /** Defines how “NA” values should be displayed/labelled in the graph */
+    naLabel?: string;
     /** Data points to highlight. Use the label value from data to highlight the data point */
     highlightedLines?: (string | number)[];
     /** Defines the opacity of the non-highlighted data */
@@ -5833,6 +5840,8 @@ declare interface Props_22 {
     highlightedDataPoints?: (string | number)[];
     /** Defines the opacity of the non-highlighted data */
     dimmedOpacity?: number;
+    /** Defines how “NA” values should be displayed/labelled in the graph */
+    naLabel?: string;
     /** Title for the bar axis */
     barAxisTitle?: string;
     /** Sorting order for data. This is overwritten by labelOrder prop. */
@@ -6328,6 +6337,8 @@ declare interface Props_29 {
     columnData: DataTableColumnDataType[];
     /** Specifies the number of decimal places to display in the value. */
     precision?: number;
+    /** Defines how “NA” values should be displayed/labelled in the graph */
+    naLabel?: string;
     /** Reset selection on double-click. Only applicable when used in a dashboard context with filters. */
     resetSelectionOnDoubleClick?: boolean;
     /** Callback for mouse click event */
@@ -6656,6 +6667,8 @@ declare interface Props_32 {
     barAxisTitle?: string;
     /** Title for the line axis */
     lineAxisTitle?: string;
+    /** Defines how “NA” values should be displayed/labelled in the graph */
+    naLabel?: string;
     /** Toggles if the graph animates in when loaded.  */
     animate?: boolean | AnimateDataType;
     /** Specifies the number of decimal places to display in the value. */
@@ -6753,6 +6766,8 @@ declare interface Props_33 {
     leftBarTitle?: string;
     /** Title for the right bars */
     rightBarTitle?: string;
+    /** Defines how “NA” values should be displayed/labelled in the graph */
+    naLabel?: string;
     /** Toggles if the graph animates in when loaded.  */
     animate?: boolean | AnimateDataType;
     /** Specifies the number of decimal places to display in the value. */
@@ -8158,6 +8173,8 @@ declare interface StackedBarChartProps {
     showColorScale?: boolean;
     /** Title for the bar axis */
     barAxisTitle?: string;
+    /** Defines how “NA” values should be displayed/labelled in the graph */
+    naLabel?: string;
     /** 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';
     /** Toggles if data points which have all the values as undefined or null are filtered out.  */