@geo2france/api-dashboard 1.20.0 → 1.21.0

package/dist/components/Charts/ChartEvolution.d.ts

@@ -0,0 +1,30 @@
+import { EChartsOption } from "echarts";
+import { datasetInput } from "../Dataset/hooks";
+export interface ChartEvolutionProps {
+    /** Identifiant du dataset */
+    dataset?: datasetInput;
+    /** Nom de la colonne qui contient les valeurs numériques */
+    valueKey: string;
+    /** Nom de la colonne qui contient les catégories */
+    nameKey?: string;
+    /** Colonne qui contient la date ou année */
+    timeKey: string;
+    /** Type de graphique */
+    chartType?: 'bar' | 'line' | 'area';
+    /** Unité à afficher */
+    unit?: string;
+    /** Titre du graphique */
+    title?: string;
+    /** Empiler les valeurs ? */
+    stack?: boolean;
+    /** Afficher un marquer sur la  ligne de temps */
+    timeMarker?: number | string;
+    /** Options suplémentaires passées à Echarts
+     * https://echarts.apache.org/en/option.html
+    */
+    option?: EChartsOption;
+}
+/** Composant de visualisation permettant de montrer l'évolution d'une valeur au cours du temps.
+ * La valeur peut-être décomposée en plusieurs catégories
+ */
+export declare const ChartEvolution: React.FC<ChartEvolutionProps>;

package/dist/components/Charts/ChartEvolution.js

@@ -0,0 +1,71 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { from, op } from "arquero";
+import deepMerge from "../../utils/deepmerge";
+import { useBlockConfig } from "../DashboardPage/Block";
+import { ChartEcharts, useDataset } from "../../dsl";
+/** Composant de visualisation permettant de montrer l'évolution d'une valeur au cours du temps.
+ * La valeur peut-être décomposée en plusieurs catégories
+ */
+export const ChartEvolution = ({ dataset: dataset_id, title, nameKey, timeKey, valueKey, chartType = 'bar', stack: stack_in, timeMarker, unit, option: custom_option = {} }) => {
+    const dataset = useDataset(dataset_id);
+    const data = dataset?.data;
+    useBlockConfig({
+        title: title,
+        dataExport: data
+    });
+    // Devnote : ajouter une propriété "timePrecision" ? (year, month, day, etc..)
+    // Ceci pourrait permettre aussi d'aggréger les données selon la précision souhaité
+    const first_time = data?.[0]?.[timeKey];
+    const yearMode = (typeof first_time === 'number' || isNaN(Number(first_time)) == false);
+    const stack = stack_in ?? (chartType !== 'line');
+    const chart_data1 = data && data.length > 0
+        ? from(data.filter(e => e[valueKey]))
+            .groupby(nameKey ? [nameKey, timeKey] : timeKey)
+            .rollup({ value: op.sum(valueKey) })
+            .orderby(timeKey)
+            .objects()
+            .map((d) => ([
+            String(d[timeKey]),
+            d.value,
+            nameKey ? d[nameKey] : valueKey // Si pas de dimension "cat", on utilise le nom la colonne de valeur
+        ]))
+        : [];
+    const cat = nameKey ?
+        data?.length ? from(data).select(nameKey).dedupe().array(nameKey) : undefined
+        : [valueKey]; // Nom de la série unique
+    const series = cat?.map((c, idx) => ({
+        type: chartType === "area" ? 'line' : chartType,
+        name: c,
+        data: chart_data1.filter(row => row[2] == c),
+        stack: stack ? 'total' : undefined,
+        connectNulls: true,
+        areaStyle: chartType === 'area' ? {} : undefined,
+        symbolSize: chartType === 'area' ? 2 : chartType === 'line' ? 4 : undefined,
+        markLine: idx === 0 && timeMarker ? {
+            symbol: 'none',
+            animation: false,
+            silent: true,
+            data: [
+                { xAxis: String(timeMarker) }
+            ]
+        } : undefined,
+    })) || [];
+    const option = {
+        legend: {
+            show: true,
+        },
+        tooltip: {
+            show: true,
+            trigger: 'axis',
+            axisPointer: {
+                // N'afficher que l'année (au lieu de la date du 1er janvier) 
+                label: { formatter: yearMode ? (p) => String(new Date(p.value).getUTCFullYear()) ?? `` : undefined }
+            },
+            valueFormatter: (v) => `${v?.toLocaleString(undefined, { maximumFractionDigits: 0 })} ${unit ?? ''}`
+        },
+        yAxis: { show: true, type: 'value' },
+        xAxis: { show: true, type: 'time' },
+        series: series,
+    };
+    return _jsx(ChartEcharts, { notMerge: true, option: deepMerge(option, custom_option) });
+};

package/dist/components/Charts/Statistics.d.ts

@@ -31,7 +31,7 @@ export interface StatisticsProps {
     /** Inverser les couleurs (rouge/vert) de l'évolution */
     invertColor?: boolean;
     /** Icône. Composant ou nom de l'icône sur https://icon-sets.iconify.design/ */
-    icon?: ReactElement | string;
+    icon?: React.ReactNode | string;
     /** Texte à afficher dans le tooltip d'aide */
     help?: string;
     /** Comparer la valeur avec la précédente ou la première du jeu de données */

package/dist/components/Control/Control.d.ts

@@ -7,13 +7,14 @@ declare const Control: React.FC<IControlProps>;
 export default Control;
 export declare const useControl: (name: string) => string | undefined;
 export declare const useAllControls: () => Record<string, any>;
-export declare const list_to_options: (input?: string[] | {
+export declare const list_to_options: (input?: string[] | number[] | {
     label: string;
-    value: string;
-}[]) => {
+    value: string | number;
+}[]) => ({
     label: string;
     value: string;
-}[];
+}[]);
+export type ListToOptionsInput = Parameters<typeof list_to_options>[0];
 interface IControlProps {
     children: ReactElement | ReactElement[];
 }

package/dist/components/Control/Control.js

@@ -44,14 +44,11 @@ export const useAllControls = () => {
 };
 /* Convenient function to return Options from list or Options */
 export const list_to_options = (input = []) => {
-    if (input === undefined) {
-        return [];
-    }
     return input.map((o) => {
-        if (typeof o == "string") {
+        if (typeof o == "string" || typeof o == "number") {
             return { label: String(o), value: String(o) };
         }
-        return o;
+        return { label: String(o.label), value: String(o.value) };
     });
 };
 export const DSL_Control = ({ children }) => {

package/dist/components/Control/Select.d.ts

@@ -1,4 +1,5 @@
 import type { SelectProps } from 'antd';
+import { ListToOptionsInput } from './Control';
 type ExtendedSelectProps = Omit<SelectProps<any>, 'options'> & {
     /** Nom technique du controle */
     name?: string;
@@ -6,11 +7,8 @@ type ExtendedSelectProps = Omit<SelectProps<any>, 'options'> & {
     label?: string;
     /** Jeu de données contenant les choix (à la place de options) */
     dataset?: string;
-    /** Choix possible */
-    options?: {
-        label: string;
-        value: string;
-    }[] | string[];
+    /** Choix possibles */
+    options?: ListToOptionsInput;
     /** Valeur intiale sélectionnée */
     initial_value?: string;
     /** Colonne à utiliser pour le libellé (si dataset utilisé) */

package/dist/components/DashboardPage/Page.d.ts

@@ -1,6 +1,6 @@
 import { RowProps } from "antd";
 import DashboardElement from "../DashboardElement/DashboardElement";
-import React from "react";
+import React, { ReactNode } from "react";
 import { Section } from "./Section";
 type Section = {
     key: string;
@@ -18,9 +18,16 @@ interface IDashboardPageProps {
 declare const DashboardPage: React.FC<IDashboardPageProps>;
 export default DashboardPage;
 interface IDSLDashboardPageProps {
-    children: React.ReactNode;
+    /** Composants visibles (dataviz, carto) ou logiques (dataset, palette) */
+    children?: ReactNode;
+    /** Nom de la page (titre). */
     name?: string;
+    /** Nombre de colonnes. */
     columns?: number;
+    /** Mode debug. Affiche un bouton permettant d'accéder aux informations développeur. */
     debug?: boolean;
 }
+/** Une page de tableau de bord.
+ * Cette page peut contenir plusieurs `Section` ou directement le contenu.
+ */
 export declare const DSL_DashboardPage: React.FC<IDSLDashboardPageProps>;

package/dist/components/DashboardPage/Page.js

@@ -1,5 +1,5 @@
 import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
-import { Button, Col, Dropdown, Flex, Grid, Layout, Radio, Row, Tabs, theme } from "antd";
+import { Button, Col, Dropdown, Empty, Flex, Grid, Layout, Radio, Row, Tabs, theme } from "antd";
 import React, { isValidElement, useState, useEffect, useContext } from "react";
 import { Helmet } from "react-helmet-async";
 import { useSearchParamsState } from "../../utils/useSearchParamsState";
@@ -41,6 +41,9 @@ const DashboardPage = ({ children: children_input, control, row_gutter = [8, 8],
                                 })), value: activeTab, onChange: (e) => setActiveTab(e.target.value) }), control] }) }), _jsx(Row, { gutter: row_gutter, style: { margin: 16 }, children: children.map((child, idx) => ({ child, idx })).filter(({ child }) => (getSection(child) ?? 'Autres') == activeTab).map(({ child, idx }) => _jsx(Col, { xl: 12, xs: 24, children: child }, idx)) })] }));
 };
 export default DashboardPage;
+/** Une page de tableau de bord.
+ * Cette page peut contenir plusieurs `Section` ou directement le contenu.
+ */
 export const DSL_DashboardPage = ({ name = 'Tableau de bord', columns = 2, children, debug = false }) => {
     const { token } = useToken();
     const [palette, setPalette] = useState(DEFAULT_PALETTE);
@@ -91,7 +94,7 @@ export const DSL_DashboardPage = ({ name = 'Tableau de bord', columns = 2, child
         items.push({
             key: "99 - Autres",
             label: '-',
-            children: _jsx(Section, { title: 'Autres', children: visible_components })
+            children: _jsx(Section, { title: 'Autres', columns: columns, children: visible_components })
         });
     }
     return (_jsxs(_Fragment, { children: [_jsx(Helmet, { children: _jsx("title", { children: name }) }), _jsxs(PaletteContext.Provider, { value: { palette, setPalette }, children: [control_components.length > 0 && _jsx(Header, { style: {
@@ -108,6 +111,8 @@ export const DSL_DashboardPage = ({ name = 'Tableau de bord', columns = 2, child
                                 background: token.colorBgContainer,
                                 borderRadius: token.borderRadiusLG }, style: { margin: 4 } })
                         :
-                            _jsxs("div", { style: { margin: 4 }, children: [" ", items?.[0].children, " "] }) //Show content without tabs if only one
-                    , logic_components, intro_component] })] }));
+                            items.length == 1 ?
+                                _jsxs("div", { style: { margin: 4 }, children: [" ", items?.[0].children, " "] }) //Show content without tabs if only one
+                                : //no visible content
+                                    _jsx(Flex, { align: "center", justify: "center", style: { height: "100%" }, children: _jsx(Empty, { description: "Ce tableau de bord est vide pour le moment.", image: _jsx(Icon, { icon: "solar:sleeping-circle-bold", height: 55, color: token.colorIcon }) }) }), logic_components, intro_component] })] }));
 };

package/dist/components/DashboardPage/Section.d.ts

@@ -1,7 +1,12 @@
-import React from "react";
+import { FC, ReactNode } from "react";
 export interface SectionProps {
+    /** Titre de la section, doit être unique */
     title: string;
-    children?: React.ReactElement | React.ReactElement[];
-    icon?: React.ReactElement | string;
+    /** Composants visibles (dataviz, carto) ou logiques (dataset, palette) */
+    children?: ReactNode;
+    /** Icone de la section. Composant ou nom (iconify) de l'icon */
+    icon?: ReactNode | string;
+    /** Nombre de colonnes. */
+    columns?: number;
 }
-export declare const Section: React.FC<SectionProps>;
+export declare const Section: FC<SectionProps>;

package/dist/components/DashboardPage/Section.js

@@ -1,9 +1,8 @@
 import { jsx as _jsx } from "react/jsx-runtime";
 import { Col, Row } from "antd";
-import React, { isValidElement } from "react";
+import { Children, isValidElement } from "react";
 import { DSL_ChartBlock } from "./Block";
-export const Section = ({ children }) => {
-    const columns = 2;
-    const childrenArray = React.Children.toArray(children).filter(isValidElement);
+export const Section = ({ children, columns = 2 }) => {
+    const childrenArray = Children.toArray(children).filter(isValidElement);
     return (_jsx(Row, { gutter: [8, 8], style: { margin: 0 }, children: childrenArray.map((component, idx) => (_jsx(Col, { xl: 24 / columns, xs: 24, children: _jsx(DSL_ChartBlock, { children: component }) }, idx))) }));
 };

package/dist/dsl/index.d.ts

@@ -24,4 +24,5 @@ import { LegendControl } from "../components/MapLegend/MapLegend";
 import { Intro } from "../components/DashboardPage/Intro";
 import { ChartComparison } from "../components/Charts/ChartComparison";
 import { DataTable } from "../components/Charts/Datatable";
-export { Dashboard, Dataset, Provider, Transform, Join, Filter, Section, Intro, DataPreview, ChartEcharts, ChartPie, ChartYearSerie, ChartComparison, DataTable, Statistics, StatisticsCollection, useDataset, useDatasets, useAllDatasets, useBlockConfig, Producer, Control, useControl, useAllControls, Radio, Select, Input, Palette, usePalette, usePaletteLabels, PalettePreview, Debug, Map, MapLayer, LegendControl };
+import { ChartEvolution } from "../components/Charts/ChartEvolution";
+export { Dashboard, Dataset, Provider, Transform, Join, Filter, Section, Intro, DataPreview, ChartEcharts, ChartPie, ChartYearSerie, ChartComparison, ChartEvolution, DataTable, Statistics, StatisticsCollection, useDataset, useDatasets, useAllDatasets, useBlockConfig, Producer, Control, useControl, useAllControls, Radio, Select, Input, Palette, usePalette, usePaletteLabels, PalettePreview, Debug, Map, MapLayer, LegendControl };

package/dist/dsl/index.js

@@ -24,4 +24,5 @@ import { LegendControl } from "../components/MapLegend/MapLegend";
 import { Intro } from "../components/DashboardPage/Intro";
 import { ChartComparison } from "../components/Charts/ChartComparison";
 import { DataTable } from "../components/Charts/Datatable";
-export { Dashboard, Dataset, Provider, Transform, Join, Filter, Section, Intro, DataPreview, ChartEcharts, ChartPie, ChartYearSerie, ChartComparison, DataTable, Statistics, StatisticsCollection, useDataset, useDatasets, useAllDatasets, useBlockConfig, Producer, Control, useControl, useAllControls, Radio, Select, Input, Palette, usePalette, usePaletteLabels, PalettePreview, Debug, Map, MapLayer, LegendControl };
+import { ChartEvolution } from "../components/Charts/ChartEvolution";
+export { Dashboard, Dataset, Provider, Transform, Join, Filter, Section, Intro, DataPreview, ChartEcharts, ChartPie, ChartYearSerie, ChartComparison, ChartEvolution, DataTable, Statistics, StatisticsCollection, useDataset, useDatasets, useAllDatasets, useBlockConfig, Producer, Control, useControl, useAllControls, Radio, Select, Input, Palette, usePalette, usePaletteLabels, PalettePreview, Debug, Map, MapLayer, LegendControl };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geo2france/api-dashboard",
-  "version": "1.20.0",
+  "version": "1.21.0",
   "private": false,
   "description": "Build dashboards with JSX/TSX",
   "main": "dist/index.js",