@ons/design-system 72.9.2 → 72.10.0

package/components/chart/utilities.js

@@ -0,0 +1,96 @@
+// Utility function to merge two configs together
+export const mergeConfigs = (baseConfig, newConfig) => {
+    // If newConfig is null/undefined, return baseConfig
+    if (!newConfig) return baseConfig;
+
+    // Create a new object to store the merged result
+    const merged = { ...baseConfig };
+
+    // Iterate through all keys in newConfig
+    Object.keys(newConfig).forEach((key) => {
+        // Get values from both configs for this key
+        const baseValue = merged[key];
+        const newValue = newConfig[key];
+
+        // If both values are objects (and not null), recursively merge them
+        if (
+            baseValue &&
+            newValue &&
+            typeof baseValue === 'object' &&
+            typeof newValue === 'object' &&
+            !Array.isArray(baseValue) &&
+            !Array.isArray(newValue)
+        ) {
+            merged[key] = mergeConfigs(baseValue, newValue);
+        } else {
+            // For non-objects and arrays use the new value
+            // If the new value is null/undefined, use the base value
+            merged[key] = newValue ?? baseValue;
+        }
+    });
+
+    return merged;
+};
+
+// Helper function to process the range and reference line annotations plus any plot lines config
+// ready to pass to the responsive rules
+export const preparePlotLinesAndBands = (
+    annotations = undefined,
+    rangeAnnotations = undefined,
+    rangeAnnotationsOptions = undefined,
+    referenceLineAnnotationsOptions = undefined,
+    commonChartOptions,
+    chartType,
+) => {
+    const totalPointAndRangeAnnotations = (annotations ? annotations.length : 0) + (rangeAnnotations ? rangeAnnotations.length : 0);
+
+    // Both range and reference line annotations are added to the axis objects, so we need to correctly combine them before we can pass them to the config.
+    let desktopRangeAnnotations = {};
+    let mobileRangeAnnotations = {};
+    let desktopReferenceLineAnnotations = {};
+    let mobileReferenceLineAnnotations = {};
+    let desktopAllPlotLines = {};
+    let mobileAllPlotLines = {};
+    let desktopAllPlotLinesAndBands = {};
+    let mobileAllPlotLinesAndBands = {};
+
+    // get the desktop and mobile range annotations
+    if (rangeAnnotationsOptions) {
+        desktopRangeAnnotations = rangeAnnotationsOptions.getRangeAnnotationsOptionsDesktop(chartType);
+        mobileRangeAnnotations = rangeAnnotationsOptions.getRangeAnnotationsOptionsMobile(annotations ? annotations.length : 0, chartType);
+    }
+
+    // get the desktop and mobile reference line annotations
+    if (referenceLineAnnotationsOptions) {
+        desktopReferenceLineAnnotations = referenceLineAnnotationsOptions.getReferenceLineAnnotationsOptionsDesktop();
+        mobileReferenceLineAnnotations = referenceLineAnnotationsOptions.getReferenceLineAnnotationsOptionsMobile(
+            totalPointAndRangeAnnotations,
+            chartType,
+        );
+    }
+
+    // We also need to combine the zero line (and any future plot lines) with the reference line annotations here, as otherwise
+    // it gets overridden by the reference line annotations config
+    let plotLineOptions = commonChartOptions.getPlotLines();
+
+    if (desktopReferenceLineAnnotations.yAxis !== undefined) {
+        let desktopMergedPlotLines = desktopReferenceLineAnnotations.yAxis.plotLines.concat(plotLineOptions.yAxis.plotLines);
+        let mobileMergedPlotLines = mobileReferenceLineAnnotations.yAxis.plotLines.concat(plotLineOptions.yAxis.plotLines);
+        desktopAllPlotLines = { ...desktopReferenceLineAnnotations };
+        mobileAllPlotLines = { ...mobileReferenceLineAnnotations };
+        desktopAllPlotLines.yAxis.plotLines = desktopMergedPlotLines;
+        mobileAllPlotLines.yAxis.plotLines = mobileMergedPlotLines;
+    } else {
+        desktopAllPlotLines = { ...plotLineOptions };
+        mobileAllPlotLines = { ...plotLineOptions };
+    }
+
+    // combine the desktop and mobile range and reference line annotations, along with other plot lines, ready to pass to the config
+    desktopAllPlotLinesAndBands = mergeConfigs(desktopRangeAnnotations, desktopAllPlotLines);
+    mobileAllPlotLinesAndBands = mergeConfigs(mobileRangeAnnotations, mobileAllPlotLines);
+
+    return {
+        desktopAllPlotLinesAndBands,
+        mobileAllPlotLinesAndBands,
+    };
+};