@j2inn/fin5-ui-utils 3.0.6 → 4.0.0

package/dist_es/react/components/charts/pie/PieChart.js

@@ -1,176 +1,176 @@
-/*
- * Copyright (c) 2023, J2 Innovations. All Rights Reserved
- */
-import * as am5 from '@amcharts/amcharts5';
-import * as am5percent from '@amcharts/amcharts5/percent';
-import React, { useEffect, useLayoutEffect, useRef, useState } from 'react';
-import { createUseStyles, useTheme } from 'react-jss';
-const useStyles = createUseStyles({
-    root: {
-        width: '100%',
-        height: '100%',
-    },
-});
-/**
- * Returns a color palette selecting some colors from the theme.
- * @param theme The theme
- * @returns An array of colors
- */
-const getDefaultChartColors = (theme) => {
-    return {
-        interfaceColors: {
-            text: theme.textColor,
-        },
-        series: [
-            theme.palette.lime,
-            theme.palette.cyan,
-            theme.palette.red,
-            theme.palette.volcano,
-            theme.palette.orange,
-            theme.palette.gold,
-            theme.palette.yellow,
-            theme.palette.green,
-            theme.palette.purple,
-            theme.palette.magenta,
-            theme.palette.blue,
-            theme.palette.grey,
-        ],
-    };
-};
-/**
- * Highly customizable pie chart component based on amcharts5
- * @see https://www.amcharts.com/docs/v5/charts/percent-charts/pie-chart/
- *
- * This component wraps some of the chart configuration trying to make it more react-friendly
- */
-export const PieChart = ({ DOMtargetId, data, colorPalette, numberFormat, chartThemes, chartSettingsProvider, legendSettingsProvider, legendLabelsSettings, legendValueLabelsSettings, legendMarkersSettings, seriesSettings, seriesLabelsSettings, centerLabelSettings, slicesSettings, sliceAdapters, }) => {
-    // Colors configuration
-    const theme = useTheme();
-    const colors = { ...getDefaultChartColors(theme), ...colorPalette };
-    // Chart lifecycle
-    const [id, setId] = useState(DOMtargetId ?? `amchart-${Math.random()}`);
-    const rootRef = useRef(null);
-    const chartRef = useRef(null);
-    const legendRef = useRef(null);
-    useEffect(() => {
-        if (DOMtargetId && DOMtargetId !== id) {
-            setId(DOMtargetId);
-        }
-    }, [DOMtargetId]);
-    // Chart setup
-    useLayoutEffect(() => {
-        const root = am5.Root.new(id);
-        // Setup amcharts theme
-        if (chartThemes) {
-            root.setThemes(chartThemes.map((t) => t.new(root)));
-        }
-        // Setup interface colors, see https://www.amcharts.com/docs/v5/concepts/colors-gradients-and-patterns/#Interface_colors
-        if (colors.interfaceColors) {
-            // Remap settings to use amcharts Color objects
-            for (const setting in colors.interfaceColors) {
-                const color = colors.interfaceColors[setting];
-                // Apply defined interfaceColor on the chart
-                root.interfaceColors.set(setting, am5.color(color));
-            }
-        }
-        // Setup chart settings
-        const chart = root.container.children.push(am5percent.PieChart.new(root, {
-            layout: root.verticalLayout,
-            ...chartSettingsProvider?.(root),
-        }));
-        // Setup legend
-        const legend = chart.children.push(am5.Legend.new(root, {
-            layout: root.horizontalLayout,
-            ...legendSettingsProvider?.(root),
-        }));
-        if (legendLabelsSettings) {
-            legend.labels.template.setAll(legendLabelsSettings);
-        }
-        if (legendValueLabelsSettings) {
-            legend.valueLabels.template.setAll(legendValueLabelsSettings);
-        }
-        if (legendMarkersSettings) {
-            legend.markers.template.setAll(legendMarkersSettings);
-        }
-        rootRef.current = root;
-        chartRef.current = chart;
-        legendRef.current = legend;
-        // clean up before component removal from the DOM
-        return () => {
-            legendRef.current?.dispose();
-            legendRef.current = null;
-            chartRef.current?.dispose();
-            chartRef.current = null;
-            root?.dispose();
-            rootRef.current = null;
-        };
-    }, [
-        id,
-        colors,
-        chartThemes,
-        chartSettingsProvider,
-        legendSettingsProvider,
-        legendValueLabelsSettings,
-        legendMarkersSettings,
-    ]);
-    // Set data
-    useEffect(() => {
-        const root = rootRef.current;
-        const chart = chartRef.current;
-        if (chart && root) {
-            chart.series.clear();
-            if (data?.length) {
-                // Setup series
-                const series = chart.series.push(am5percent.PieSeries.new(root, {
-                    valueField: 'value',
-                    categoryField: 'category',
-                    ...seriesSettings,
-                }));
-                // Setup series labels
-                if (seriesLabelsSettings) {
-                    series.labels.template.setAll(seriesLabelsSettings);
-                }
-                // Setup center label
-                if (centerLabelSettings) {
-                    series.children.push(am5.Label.new(root, {
-                        ...centerLabelSettings,
-                    }));
-                }
-                // Setup series slices
-                if (slicesSettings) {
-                    series.slices.template.setAll(slicesSettings);
-                }
-                // Setup slice adapters
-                if (sliceAdapters) {
-                    sliceAdapters.forEach(([key, callbackMaker]) => series.slices.template.adapters.add(key, callbackMaker({
-                        root: root,
-                        chart: chart,
-                        series,
-                    })));
-                }
-                // Setup series colors
-                if (colors?.series) {
-                    series.get('colors')?.set('colors', colors.series.map((c) => am5.color(c)));
-                }
-                series.data.setAll(data);
-                legendRef.current?.data.setAll(series.dataItems);
-            }
-        }
-    }, [
-        data,
-        chartRef.current,
-        colors?.series,
-        seriesSettings,
-        slicesSettings,
-        seriesLabelsSettings,
-        sliceAdapters,
-    ]);
-    useEffect(() => {
-        if (numberFormat) {
-            rootRef.current?.numberFormatter.set('numberFormat', numberFormat);
-        }
-    }, [rootRef.current, numberFormat]);
-    const classes = useStyles();
-    return React.createElement("div", { id: id, className: classes.root });
-};
+/*
+ * Copyright (c) 2023, J2 Innovations. All Rights Reserved
+ */
+import * as am5 from '@amcharts/amcharts5';
+import * as am5percent from '@amcharts/amcharts5/percent';
+import React, { useEffect, useLayoutEffect, useRef, useState } from 'react';
+import { createUseStyles, useTheme } from 'react-jss';
+const useStyles = createUseStyles({
+    root: {
+        width: '100%',
+        height: '100%',
+    },
+});
+/**
+ * Returns a color palette selecting some colors from the theme.
+ * @param theme The theme
+ * @returns An array of colors
+ */
+const getDefaultChartColors = (theme) => {
+    return {
+        interfaceColors: {
+            text: theme.textColor,
+        },
+        series: [
+            theme.palette.lime,
+            theme.palette.cyan,
+            theme.palette.red,
+            theme.palette.volcano,
+            theme.palette.orange,
+            theme.palette.gold,
+            theme.palette.yellow,
+            theme.palette.green,
+            theme.palette.purple,
+            theme.palette.magenta,
+            theme.palette.blue,
+            theme.palette.grey,
+        ],
+    };
+};
+/**
+ * Highly customizable pie chart component based on amcharts5
+ * @see https://www.amcharts.com/docs/v5/charts/percent-charts/pie-chart/
+ *
+ * This component wraps some of the chart configuration trying to make it more react-friendly
+ */
+export const PieChart = ({ DOMtargetId, data, colorPalette, numberFormat, chartThemes, chartSettingsProvider, legendSettingsProvider, legendLabelsSettings, legendValueLabelsSettings, legendMarkersSettings, seriesSettings, seriesLabelsSettings, centerLabelSettings, slicesSettings, sliceAdapters, }) => {
+    // Colors configuration
+    const theme = useTheme();
+    const colors = { ...getDefaultChartColors(theme), ...colorPalette };
+    // Chart lifecycle
+    const [id, setId] = useState(DOMtargetId ?? `amchart-${Math.random()}`);
+    const rootRef = useRef(null);
+    const chartRef = useRef(null);
+    const legendRef = useRef(null);
+    useEffect(() => {
+        if (DOMtargetId && DOMtargetId !== id) {
+            setId(DOMtargetId);
+        }
+    }, [DOMtargetId]);
+    // Chart setup
+    useLayoutEffect(() => {
+        const root = am5.Root.new(id);
+        // Setup amcharts theme
+        if (chartThemes) {
+            root.setThemes(chartThemes.map((t) => t.new(root)));
+        }
+        // Setup interface colors, see https://www.amcharts.com/docs/v5/concepts/colors-gradients-and-patterns/#Interface_colors
+        if (colors.interfaceColors) {
+            // Remap settings to use amcharts Color objects
+            for (const setting in colors.interfaceColors) {
+                const color = colors.interfaceColors[setting];
+                // Apply defined interfaceColor on the chart
+                root.interfaceColors.set(setting, am5.color(color));
+            }
+        }
+        // Setup chart settings
+        const chart = root.container.children.push(am5percent.PieChart.new(root, {
+            layout: root.verticalLayout,
+            ...chartSettingsProvider?.(root),
+        }));
+        // Setup legend
+        const legend = chart.children.push(am5.Legend.new(root, {
+            layout: root.horizontalLayout,
+            ...legendSettingsProvider?.(root),
+        }));
+        if (legendLabelsSettings) {
+            legend.labels.template.setAll(legendLabelsSettings);
+        }
+        if (legendValueLabelsSettings) {
+            legend.valueLabels.template.setAll(legendValueLabelsSettings);
+        }
+        if (legendMarkersSettings) {
+            legend.markers.template.setAll(legendMarkersSettings);
+        }
+        rootRef.current = root;
+        chartRef.current = chart;
+        legendRef.current = legend;
+        // clean up before component removal from the DOM
+        return () => {
+            legendRef.current?.dispose();
+            legendRef.current = null;
+            chartRef.current?.dispose();
+            chartRef.current = null;
+            root?.dispose();
+            rootRef.current = null;
+        };
+    }, [
+        id,
+        colors,
+        chartThemes,
+        chartSettingsProvider,
+        legendSettingsProvider,
+        legendValueLabelsSettings,
+        legendMarkersSettings,
+    ]);
+    // Set data
+    useEffect(() => {
+        const root = rootRef.current;
+        const chart = chartRef.current;
+        if (chart && root) {
+            chart.series.clear();
+            if (data?.length) {
+                // Setup series
+                const series = chart.series.push(am5percent.PieSeries.new(root, {
+                    valueField: 'value',
+                    categoryField: 'category',
+                    ...seriesSettings,
+                }));
+                // Setup series labels
+                if (seriesLabelsSettings) {
+                    series.labels.template.setAll(seriesLabelsSettings);
+                }
+                // Setup center label
+                if (centerLabelSettings) {
+                    series.children.push(am5.Label.new(root, {
+                        ...centerLabelSettings,
+                    }));
+                }
+                // Setup series slices
+                if (slicesSettings) {
+                    series.slices.template.setAll(slicesSettings);
+                }
+                // Setup slice adapters
+                if (sliceAdapters) {
+                    sliceAdapters.forEach(([key, callbackMaker]) => series.slices.template.adapters.add(key, callbackMaker({
+                        root: root,
+                        chart: chart,
+                        series,
+                    })));
+                }
+                // Setup series colors
+                if (colors?.series) {
+                    series.get('colors')?.set('colors', colors.series.map((c) => am5.color(c)));
+                }
+                series.data.setAll(data);
+                legendRef.current?.data.setAll(series.dataItems);
+            }
+        }
+    }, [
+        data,
+        chartRef.current,
+        colors?.series,
+        seriesSettings,
+        slicesSettings,
+        seriesLabelsSettings,
+        sliceAdapters,
+    ]);
+    useEffect(() => {
+        if (numberFormat) {
+            rootRef.current?.numberFormatter.set('numberFormat', numberFormat);
+        }
+    }, [rootRef.current, numberFormat]);
+    const classes = useStyles();
+    return React.createElement("div", { id: id, className: classes.root });
+};
 //# sourceMappingURL=PieChart.js.map

package/dist_es/react/components/charts/pie/SimplePieChart.d.ts

@@ -1,20 +1,20 @@
-import React from 'react';
-import { PieChartColorPalette, PieChartSliceData } from './PieChart';
-export interface SimplePieChartProps {
-    data: PieChartSliceData[];
-    donut?: boolean;
-    animated?: boolean;
-    colorPalette?: Partial<PieChartColorPalette>;
-    tooltipFormat?: string;
-    numberFormat?: Intl.NumberFormatOptions;
-    hideLabels?: boolean;
-    /**
-     * Optional DOM id for the chart container, if not specified it will be automatically generated
-     */
-    DOMtargetId?: string;
-}
-/**
- * Simplified version of the pie chart for quick usage and easy configuration.
- * Serves also as an example of how to use the underlying PieChart component.
- */
-export declare const SimplePieChart: React.FC<SimplePieChartProps>;
+import React from 'react';
+import { PieChartColorPalette, PieChartSliceData } from './PieChart';
+export interface SimplePieChartProps {
+    data: PieChartSliceData[];
+    donut?: boolean;
+    animated?: boolean;
+    colorPalette?: Partial<PieChartColorPalette>;
+    tooltipFormat?: string;
+    numberFormat?: Intl.NumberFormatOptions;
+    hideLabels?: boolean;
+    /**
+     * Optional DOM id for the chart container, if not specified it will be automatically generated
+     */
+    DOMtargetId?: string;
+}
+/**
+ * Simplified version of the pie chart for quick usage and easy configuration.
+ * Serves also as an example of how to use the underlying PieChart component.
+ */
+export declare const SimplePieChart: React.FC<SimplePieChartProps>;

package/dist_es/react/components/charts/pie/SimplePieChart.js

@@ -1,26 +1,26 @@
-/*
- * Copyright (c) 2023, J2 Innovations. All Rights Reserved
- */
-import * as am5 from '@amcharts/amcharts5';
-import am5themes_Animated from '@amcharts/amcharts5/themes/Animated';
-import React from 'react';
-import { PieChart } from './PieChart';
-/**
- * Simplified version of the pie chart for quick usage and easy configuration.
- * Serves also as an example of how to use the underlying PieChart component.
- */
-export const SimplePieChart = ({ data, donut, animated, colorPalette, tooltipFormat, numberFormat = {
-    style: 'decimal',
-    minimumFractionDigits: 0,
-    maximumFractionDigits: 1,
-}, hideLabels, DOMtargetId, }) => {
-    return (React.createElement(PieChart, { DOMtargetId: DOMtargetId, colorPalette: colorPalette, data: data, chartThemes: animated ? [am5themes_Animated] : undefined, chartSettingsProvider: () => ({
-            innerRadius: donut ? am5.percent(55) : undefined,
-        }), numberFormat: numberFormat, legendSettingsProvider: () => ({
-            centerX: am5.percent(50),
-            x: am5.percent(50),
-        }), seriesLabelsSettings: { forceHidden: hideLabels }, seriesSettings: { alignLabels: false }, slicesSettings: {
-            tooltipText: tooltipFormat,
-        } }));
-};
+/*
+ * Copyright (c) 2023, J2 Innovations. All Rights Reserved
+ */
+import * as am5 from '@amcharts/amcharts5';
+import am5themes_Animated from '@amcharts/amcharts5/themes/Animated';
+import React from 'react';
+import { PieChart } from './PieChart';
+/**
+ * Simplified version of the pie chart for quick usage and easy configuration.
+ * Serves also as an example of how to use the underlying PieChart component.
+ */
+export const SimplePieChart = ({ data, donut, animated, colorPalette, tooltipFormat, numberFormat = {
+    style: 'decimal',
+    minimumFractionDigits: 0,
+    maximumFractionDigits: 1,
+}, hideLabels, DOMtargetId, }) => {
+    return (React.createElement(PieChart, { DOMtargetId: DOMtargetId, colorPalette: colorPalette, data: data, chartThemes: animated ? [am5themes_Animated] : undefined, chartSettingsProvider: () => ({
+            innerRadius: donut ? am5.percent(55) : undefined,
+        }), numberFormat: numberFormat, legendSettingsProvider: () => ({
+            centerX: am5.percent(50),
+            x: am5.percent(50),
+        }), seriesLabelsSettings: { forceHidden: hideLabels }, seriesSettings: { alignLabels: false }, slicesSettings: {
+            tooltipText: tooltipFormat,
+        } }));
+};
 //# sourceMappingURL=SimplePieChart.js.map

package/dist_es/react/components/graphics/GraphicViewer.d.ts

@@ -1,10 +1,10 @@
-import { HRef } from 'haystack-core';
-import React from 'react';
-interface GraphicViewerProps {
-    projectName?: string;
-    graphicId: HRef;
-    targetRef: HRef;
-    className?: string;
-}
-export declare const GraphicViewer: React.FC<GraphicViewerProps>;
-export {};
+import { HRef } from 'haystack-core';
+import React from 'react';
+interface GraphicViewerProps {
+    projectName?: string;
+    graphicId: HRef;
+    targetRef: HRef;
+    className?: string;
+}
+export declare const GraphicViewer: React.FC<GraphicViewerProps>;
+export {};

package/dist_es/react/components/graphics/GraphicViewer.js

@@ -1,23 +1,23 @@
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-import cn from 'classnames';
-import React from 'react';
-import { createUseStyles } from 'react-jss';
-import { fin5Top } from '../../../fin5Top/fin5Top';
-const useStyles = createUseStyles({
-    iframe: {
-        width: '100%',
-        height: '100%',
-        border: 0,
-        overflow: 'hidden',
-    },
-});
-export const GraphicViewer = ({ projectName = fin5Top?.finstack?.projectName ?? '', graphicId, targetRef, className, }) => {
-    const classes = useStyles();
-    const url = new URL(`${window.location.protocol}//${window.location.host}/fin5/${projectName}`);
-    url.hash = `targetRef=${targetRef.toAxon()}`;
-    url.searchParams.set('projectRef', graphicId.toAxon());
-    return (React.createElement("iframe", { id: graphicId.toAxon(), className: cn(classes.iframe, className), src: url.toString() }));
-};
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+import cn from 'classnames';
+import React from 'react';
+import { createUseStyles } from 'react-jss';
+import { fin5Top } from '../../../fin5Top/fin5Top';
+const useStyles = createUseStyles({
+    iframe: {
+        width: '100%',
+        height: '100%',
+        border: 0,
+        overflow: 'hidden',
+    },
+});
+export const GraphicViewer = ({ projectName = fin5Top?.finstack?.projectName ?? '', graphicId, targetRef, className, }) => {
+    const classes = useStyles();
+    const url = new URL(`${window.location.protocol}//${window.location.host}/fin5/${projectName}`);
+    url.hash = `targetRef=${targetRef.toAxon()}`;
+    url.searchParams.set('projectRef', graphicId.toAxon());
+    return (React.createElement("iframe", { id: graphicId.toAxon(), className: cn(classes.iframe, className), src: url.toString() }));
+};
 //# sourceMappingURL=GraphicViewer.js.map

package/dist_es/react/components/graphics/GraphicsTabViewer.d.ts

@@ -1,17 +1,17 @@
-import { HRef } from 'haystack-core';
-import React from 'react';
-interface GraphicsTabViewer {
-    projectName?: string;
-    targetRef: HRef;
-    className?: string;
-    /**
-     * Set it to true if you want to query also for related graphics (graphics applicable to objects linked by refs),
-     * false to just get the graphics on this target.
-     * @default false
-     */
-    queryRelated?: boolean;
-    fallbackClassName?: string;
-    fallbackText?: string;
-}
-export declare const GraphicsTabViewer: React.FC<GraphicsTabViewer>;
-export {};
+import { HRef } from 'haystack-core';
+import React from 'react';
+interface GraphicsTabViewer {
+    projectName?: string;
+    targetRef: HRef;
+    className?: string;
+    /**
+     * Set it to true if you want to query also for related graphics (graphics applicable to objects linked by refs),
+     * false to just get the graphics on this target.
+     * @default false
+     */
+    queryRelated?: boolean;
+    fallbackClassName?: string;
+    fallbackText?: string;
+}
+export declare const GraphicsTabViewer: React.FC<GraphicsTabViewer>;
+export {};