Metric format converter

frontend/taipy-gui/src/components/Taipy/Metric.tsx

@@ -11,22 +11,11 @@
  * specific language governing permissions and limitations under the License.
  */
 
-import React, {
-    CSSProperties,
-    lazy,
-    Suspense,
-    useMemo
-} from 'react';
+import React, {CSSProperties, lazy, Suspense, useMemo} from 'react';
 import {Data} from "plotly.js";
-import {
-    useClassNames,
-    useDynamicJsonProperty,
-    useDynamicProperty
-} from "../../utils/hooks";
-import {
-    TaipyBaseProps,
-    TaipyHoverProps
-} from "./utils";
+import {useClassNames, useDynamicJsonProperty, useDynamicProperty} from "../../utils/hooks";
+import {extractPrefix, extractSuffix, sprintfToD3Converter} from "../../utils/formatConversion";
+import {TaipyBaseProps, TaipyHoverProps} from "./utils";
 import Box from "@mui/material/Box";
 import Skeleton from "@mui/material/Skeleton";
 
@@ -50,6 +39,8 @@
     width?: string | number;
     height?: string | number;
     showValue?: boolean;
+    format?: string;
+    deltaFormat?: string;
 }
 
 const emptyLayout = {} as Record<string, Record<string, unknown>>;
@@ -68,37 +59,49 @@
     const baseLayout = useDynamicJsonProperty(props.layout, props.defaultLayout || "", emptyLayout);
     const baseStyle = useDynamicJsonProperty(props.style, props.defaultStyle || "", defaultStyle);
 
-    const data = useMemo(() => ([
-        {
-            domain: {x: [0, 1], y: [0, 1]},
-            value: value,
-            type: "indicator",
-            mode: "gauge" + (showValue ? "+number" : "")  + (delta !== undefined ? "+delta" : ""),
-            delta: {
-                reference: typeof value === 'number' && typeof delta === 'number' ? value - delta : undefined,
-            },
-            gauge: {
-                axis: {
-                    range: [
-                        typeof props.min === 'number' ? props.min : 0,
-                        typeof props.max === 'number' ? props.max : 100
-                    ]
+    const data = useMemo(() => {
+        return [
+            {
+                domain: {x: [0, 1], y: [0, 1]},
+                value: value,
+                type: "indicator",
+                mode: "gauge" + (showValue ? "+number" : "") + (delta !== undefined ? "+delta" : ""),
+                number: {
+                    prefix: extractPrefix(props.format !== undefined ? props.format : ""),
+                    suffix: extractSuffix(props.format !== undefined ? props.format : ""),
+                    valueformat: sprintfToD3Converter(props.format !== undefined ? props.format : ""),
                 },
-                shape: props.type === "linear" ? "bullet" : "angular",
-                threshold: {
-                    line: {color: "red", width: 4},
-                    thickness: 0.75,
-                    value: threshold
-                }
-            },
-        }
-    ]), [
-        value,
-        showValue,
-        delta,
+                delta: {
+                    reference: typeof value === 'number' && typeof delta === 'number' ? value - delta : undefined,
+                    prefix: extractPrefix(props.deltaFormat !== undefined ? props.deltaFormat : ""),
+                    suffix: extractSuffix(props.deltaFormat !== undefined ? props.deltaFormat : ""),
+                    valueformat: sprintfToD3Converter(props.deltaFormat !== undefined ? props.deltaFormat : "")
+                },
+                gauge: {
+                    axis: {
+                        range: [
+                            props.min ?? 0,
+                            props.max ?? 100
+                        ]
+                    },
+                    shape: props.type === "linear" ? "bullet" : "angular",
+                    threshold: {
+                        line: {color: "red", width: 4},
+                        thickness: 0.75,
+                        value: threshold
+                    }
+                },
+            }
+        ];
+    }, [
+        props.format,
+        props.deltaFormat,
         props.min,
         props.max,
         props.type,
+        value,
+        showValue,
+        delta,
         threshold
     ]);
 
@@ -119,6 +122,7 @@
                     data={data as Data[]}
                     layout={baseLayout}
                     style={style}
+                    useResizeHandler
                 />
             </Suspense>
         </Box>

frontend/taipy-gui/src/utils/formatConversion.ts

@@ -0,0 +1,120 @@
+/*
+ * Copyright 2021-2024 Avaiga Private Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ */
+
+/**
+ * Regular expressions used for parsing sprintf format strings.
+ */
+const re = {
+    text: /^[^\x25]+/,                         // Matches non-placeholder text
+    modulo: /^\x25{2}/,                        // Matches the '%%' escape sequence
+    placeholder: /^\x25?(?:\.(\d+))?([b-giostuvxX])/, // Matches placeholders
+};
+
+/**
+ * Parses a sprintf format string and returns a parse tree.
+ * @param fmt The sprintf format string.
+ * @returns The parse tree representing the structure of the format string.
+ */
+const sprintf_parse = (fmt: string) => {
+    let _fmt = fmt;
+    let match;
+    const parse_tree = [];
+
+    while (_fmt) {
+        if ((match = re.text.exec(_fmt)) !== null) {
+            // Non-placeholder text
+            parse_tree.push(match[0]);
+        } else if ((match = re.modulo.exec(_fmt)) !== null) {
+            // '%%' escape sequence
+            parse_tree.push('%');
+        } else if ((match = re.placeholder.exec(_fmt)) !== null) {
+            // Placeholder
+            if (match && match[0]) {
+                parse_tree.push({
+                    placeholder: match[0],
+                });
+            }
+        }
+
+        if (match) {
+            _fmt = _fmt.substring(match[0].length);
+        }
+    }
+
+    return parse_tree;
+}
+
+/**
+ * Converts sprintf format string to a D3 format string.
+ * @param format The sprintf format string.
+ * @returns The D3 format string.
+ */
+export const sprintfToD3Converter = (format: string) => {
+    const precisionFormat = (precision: string | undefined, specifier: string) => {
+        // Default to precision of 2 if not specified
+        return "." + (precision?.slice(1) ?? "2") + specifier;
+    }
+
+    const sprintf_fmt_arr = sprintf_parse(format);
+    const objectIndex = sprintf_fmt_arr.findIndex((element) => typeof element === 'object');
+    let placeholderValue;
+
+    if (typeof sprintf_fmt_arr[objectIndex] === 'object' && sprintf_fmt_arr[objectIndex] !== null) {
+        placeholderValue = (sprintf_fmt_arr[objectIndex] as { placeholder: string }).placeholder;
+    }
+
+    return placeholderValue?.replace(/%([0-9]*)([.][0-9]+)?([bdieufgoxX])/g, (match, width, precision, type) => {
+        switch (type) {
+            case "b":
+            case "d":
+            case "e":
+            case "o":
+            case "x":
+            case "X":
+                return type;
+            case "i":
+                return "d";
+            case "f":
+                return precisionFormat(precision, "f");
+            case "g":
+                return precisionFormat(precision, "g");
+            case "u":
+                return "("
+            default:
+                return "";
+        }
+    });
+}
+
+/**
+ * Extracts the prefix from a sprintf format string.
+ * @param format The sprintf format string.
+ * @returns The prefix.
+ */
+export const extractPrefix = (format: string) => {
+    const sprintf_fmt_arr = sprintf_parse(format);
+    const objectIndex = sprintf_fmt_arr.findIndex((element) => typeof element === 'object');
+    return sprintf_fmt_arr.slice(0, objectIndex).join('');
+}
+
+/**
+ * Extracts the suffix from a sprintf format string.
+ * @param format The sprintf format string.
+ * @returns The suffix.
+ */
+export const extractSuffix = (format: string) => {
+    const sprintf_fmt_arr = sprintf_parse(format);
+    const objectIndex = sprintf_fmt_arr.findIndex((element) => typeof element === 'object');
+    return sprintf_fmt_arr.slice(objectIndex + 1).join('');
+}
+

pytest.ini

@@ -9,5 +9,6 @@ filterwarnings =
     ignore::FutureWarning:pyarrow
 markers =
     teste2e:End-to-end tests
+    extension:Taipy GUI Extension tests
     orchestrator_dispatcher:Orchestrator dispatcher tests
     standalone:Tests starting a standalone dispatcher thread

taipy/gui/_renderers/factory.py

@@ -371,6 +371,8 @@ class _Factory:
                 ("width", PropertyType.string_or_number),
                 ("height", PropertyType.string_or_number),
                 ("show_value", PropertyType.boolean, True),
+                ("format", PropertyType.string),
+                ("delta_format", PropertyType.string),
             ]
         ),
         "navbar": lambda gui, control_type, attrs: _Builder(

taipy/gui/viselements.json

@@ -895,6 +895,18 @@
                         "type": "str|number",
                         "default_value": "None",
                         "doc": "The height, in CSS units, of the metric."
+                    },
+                    {
+                        "name": "format",
+                        "type": "str",
+                        "default_value": "None",
+                        "doc": "The format to use when displaying the value.<br/>This uses the <code>printf</code> syntax."
+                    },
+                    {
+                        "name": "delta_format",
+                        "type": "str",
+                        "default_value": "None",
+                        "doc": "The format to use when displaying the delta value.<br/>This uses the <code>printf</code> syntax."
                     }
                 ]
             }