@geo2france/api-dashboard 1.18.0 → 1.20.0

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

@@ -0,0 +1,28 @@
+import { EChartsOption } from "echarts";
+import { datasetInput } from "../Dataset/hooks";
+type labelType = "percent" | "value" | "category" | "none";
+export interface ChartComparisonProps {
+    /** 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;
+    /** Type de graphique */
+    chartType?: 'bar' | 'pie' | 'donut';
+    /** Unité à afficher */
+    unit?: string;
+    /** Titre du graphique */
+    title?: string;
+    /** Valeur à afficher en étiquette */
+    label?: labelType;
+    /** Couleur unique pour le graphique */
+    singleColor?: boolean;
+    /** Options suplémentaires passées à Echarts
+     * https://echarts.apache.org/en/option.html
+    */
+    option?: EChartsOption;
+}
+/** Composant de visualisation destiné à comparer des catégories au sein d’un dataset. */
+export declare const ChartComparison: React.FC<ChartComparisonProps>;
+export {};

package/dist/components/Charts/ChartComparison.js

@@ -0,0 +1,95 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { useDataset } from "../Dataset/hooks";
+import { ChartEcharts, useBlockConfig, usePalette, usePaletteLabels } from "../../dsl";
+import { from, op } from "arquero";
+import deepMerge from "../../utils/deepmerge";
+/** Composant de visualisation destiné à comparer des catégories au sein d’un dataset. */
+export const ChartComparison = ({ dataset: dataset_id, title, nameKey, valueKey, chartType = 'bar', unit, singleColor = false, label: label_in, option: custom_option = {} }) => {
+    const dataset = useDataset(dataset_id);
+    const data = dataset?.data;
+    useBlockConfig({
+        title: title,
+        dataExport: data
+    });
+    // Label par défaut selon le type de graphique
+    const label = label_in ?? ((chartType === 'pie' || chartType === 'donut') ? 'category' : 'none');
+    const chart_data1 = data && data.length > 0
+        ? from(data.filter(e => e[valueKey]))
+            .groupby(nameKey)
+            .rollup({ value: op.sum(valueKey) })
+            .orderby('value')
+            .objects()
+            .map((d) => ([
+            d[nameKey], //0
+            d.value, //1
+        ]))
+        : [];
+    const colors_libels = usePaletteLabels();
+    const colors_palette = usePalette({ nColors: chart_data1.length }) || ['#d4d4d4'];
+    // Total, utilisé pour les pourcentage
+    const total = chart_data1?.reduce((sum, item) => sum + item[1], 0);
+    const labelFormatter = (v) => {
+        if (!label || label == 'none')
+            return '';
+        const value = (chartType === 'pie' || chartType === 'donut') ?
+            v?.value
+            : v?.value?.[1];
+        const name = v?.name;
+        switch (label) {
+            case 'percent': {
+                return ((100 * value / total).toLocaleString(undefined, {
+                    maximumFractionDigits: 0,
+                }) + ' %');
+            }
+            case 'value':
+                return `${value.toLocaleString(undefined, {
+                    maximumFractionDigits: 0,
+                })}  ${unit || ''}`;
+            case 'category':
+                return name;
+            default:
+                return '';
+        }
+    };
+    const serie_common = {
+        itemStyle: {
+            color: (p) => singleColor ? colors_palette?.[0] :
+                colors_libels.find(c => c.label == p.data[0] || c.label == p.name)?.color || colors_palette?.[p.dataIndex]
+        },
+    };
+    const serie = chartType == 'bar' ?
+        {
+            type: 'bar',
+            data: chart_data1?.map(r => [r[0], r[1]]),
+            label: {
+                show: label && label !== 'none',
+                position: 'right',
+                formatter: labelFormatter
+            },
+            encode: {
+                x: 1,
+                y: 0
+            },
+            ...serie_common,
+        } :
+        {
+            type: 'pie',
+            radius: chartType == 'donut' ? ['40%', '75%'] : [0, '75%'],
+            data: chart_data1?.map(r => ({ name: r[0], value: r[1] })),
+            label: {
+                show: label && label !== 'none',
+                formatter: labelFormatter
+            },
+            ...serie_common,
+        };
+    const option = {
+        tooltip: {
+            show: true,
+            valueFormatter: (v) => `${v?.toLocaleString(undefined, { maximumFractionDigits: 0 })} t`
+        },
+        yAxis: { show: chartType == 'bar', type: 'category' },
+        xAxis: { show: chartType == 'bar', type: 'value', axisLabel: { formatter: (v) => `${(v).toLocaleString()} ${unit}` } },
+        series: [serie],
+    };
+    return _jsx(ChartEcharts, { option: deepMerge(option, custom_option) });
+};

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

@@ -0,0 +1,14 @@
+import { datasetInput } from "../Dataset/hooks";
+export interface DataTableProps {
+    /** Jeu de données */
+    dataset: datasetInput;
+    /** Titre du composant */
+    title?: string;
+    /** Nombre d'éléments par page */
+    pageSize?: number;
+    /** Style CSS du tableau */
+    style?: React.CSSProperties;
+}
+/** Afficher un dataset sous forme de tableau
+ */
+export declare const DataTable: React.FC<DataTableProps>;

package/dist/components/Charts/Datatable.js

@@ -0,0 +1,22 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { Table } from "antd";
+import { useDataset } from "../Dataset/hooks";
+import { useBlockConfig } from "../DashboardPage/Block";
+/** Afficher un dataset sous forme de tableau
+ */
+export const DataTable = ({ dataset: dataset_id, title, pageSize = 5, style }) => {
+    const dataset = useDataset(dataset_id); //Récupérer le jeu de données
+    const data = dataset?.data;
+    useBlockConfig({
+        title: title,
+        dataExport: data
+    });
+    const cols = Object.keys(data?.[0] || {})?.map((k) => ({
+        dataIndex: k,
+        title: k,
+        ellipsis: true,
+        key: k,
+        render: (v) => typeof v === 'number' ? isNaN(v) ? '' : v.toLocaleString() : v,
+    }));
+    return _jsx(Table, { columns: cols, style: style, className: "data-table", dataSource: Array.isArray(data) ? data?.map((r, idx) => ({ ...r, key: idx })) : [], pagination: { pageSize: pageSize } });
+};

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

@@ -1,8 +1,9 @@
+import { datasetInput } from "../Dataset/hooks";
 import { EChartsOption, LabelFormatterCallback } from "echarts";
 import type { CallbackDataParams } from 'echarts/types/dist/shared';
 export interface IChartPieProps {
     /** Identifiant du dataset */
-    dataset?: string;
+    dataset?: datasetInput;
     /** Nom de la colonne qui contient les valeurs numériques */
     dataKey: string;
     /** Nom de la colonne qui contient les catégories */

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

@@ -1,4 +1,5 @@
 import { ReactElement } from "react";
+import { datasetInput } from "../Dataset/hooks";
 import { SimpleRecord } from "../../types";
 type comparwithType = "first" | "previous";
 type aggregateType = "last" | "first" | "sum" | "lastNotNull" | "min" | "max" | "count" | "mean" | "countDistinct" | "countMissing";
@@ -13,8 +14,8 @@ interface ICallbackParams {
     compareValue: number;
 }
 export interface StatisticsProps {
-    /** Identifiant du jeu de données */
-    dataset: string;
+    /** Identifiant du jeu de données ou tableau de valeurs */
+    dataset: datasetInput;
     /** Nom de la colonne qui contient les valeurs */
     dataKey: string;
     /** Texte à afficher après l'évolution */
@@ -29,7 +30,7 @@ export interface StatisticsProps {
     unit?: string;
     /** Inverser les couleurs (rouge/vert) de l'évolution */
     invertColor?: boolean;
-    /** Icône (composant ou nom de l'icône sur Iconify.js ) */
+    /** Icône. Composant ou nom de l'icône sur https://icon-sets.iconify.design/ */
     icon?: ReactElement | string;
     /** Texte à afficher dans le tooltip d'aide */
     help?: string;
@@ -37,7 +38,7 @@ export interface StatisticsProps {
     compareWith?: comparwithType;
     /** Texte d'annotation (remplace evolution si définie) */
     annotation?: React.ReactNode | ((param: ICallbackParams) => React.ReactNode);
-    /** Fonction a appliquer avant rendu */
+    /** Fonction de formattager a appliquer avant rendu */
     valueFormatter?: ((param: ICallbackParams) => string);
     /** Méthode d'aggrégation */
     aggregate?: aggregateType;
@@ -45,17 +46,7 @@ export interface StatisticsProps {
     animation?: boolean;
 }
 /**
- * Composant `Statistics` affichant une valeur d'un dataset avec son évolution.
- *
- * Affiche :
- * - La dernière valeur du dataset
- * - Unité et picto
- * - Évolution par rapport à la première ou l'avant-dernière valeur
- * - Couleur selon évolution positive/négative
- * - Tooltip d'aide si fourni
- *
- * @param {StatisticsProps} props - Propriétés du composant
- * @returns {ReactElement} Carte statistique
+ * Composant `Statistics` affichant une valeur depuis un dataset.
  */
 export declare const Statistics: React.FC<StatisticsProps>;
 export interface StatisticsCollectionProps {
@@ -73,7 +64,7 @@ export interface StatisticsCollectionProps {
     title?: string;
 }
 /**
- * `StatisticsCollection` permet de regrouper plusieurs cartes statistiques
+ * `StatisticsCollection` permet de regrouper plusieurs cartes [`Statistics`](?path=/docs/dataviz-statistics--docs)
  * dans un bloc
  * ```
  */

package/dist/components/Charts/Statistics.js

@@ -10,19 +10,13 @@ import CountUp from "react-countup";
 const { Text, Paragraph } = Typography;
 // DEV : modele cf https://bootstrapbrain.com/component/bootstrap-statistics-card-example/
 /**
- * Composant `Statistics` affichant une valeur d'un dataset avec son évolution.
- *
- * Affiche :
- * - La dernière valeur du dataset
- * - Unité et picto
- * - Évolution par rapport à la première ou l'avant-dernière valeur
- * - Couleur selon évolution positive/négative
- * - Tooltip d'aide si fourni
- *
- * @param {StatisticsProps} props - Propriétés du composant
- * @returns {ReactElement} Carte statistique
+ * Composant `Statistics` affichant une valeur depuis un dataset.
  */
-export const Statistics = ({ dataset: dataset_id, dataKey, unit, evolutionSuffix, title, icon: icon_input, color, invertColor = false, help, compareWith, relativeEvolution = false, valueFormatter = (param) => (param.value.toLocaleString()), annotation, aggregate = "last", animation = false }) => {
+export const Statistics = ({ dataset: dataset_id, dataKey, unit, evolutionSuffix, // A supprimer
+title, icon: icon_input, color, invertColor = false, // A supprimer
+help, compareWith, // A supprimer
+relativeEvolution = false, // A supprimer
+valueFormatter = (param) => (param.value.toLocaleString()), annotation, aggregate = "last", animation = false }) => {
     const icon = typeof icon_input === "string" ? _jsx(Icon, { icon: icon_input }) : icon_input;
     const dataset = useDataset(dataset_id);
     const { row, value } = aggregator({ data: dataset?.data, dataKey, aggregate });
@@ -64,7 +58,7 @@ export const Statistics = ({ dataset: dataset_id, dataKey, unit, evolutionSuffix
 };
 ;
 /**
- * `StatisticsCollection` permet de regrouper plusieurs cartes statistiques
+ * `StatisticsCollection` permet de regrouper plusieurs cartes [`Statistics`](?path=/docs/dataviz-statistics--docs)
  * dans un bloc
  * ```
  */

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

@@ -1,9 +1,10 @@
 /**
  * Graphique standard pour afficher des données annuelles
  */
+import { datasetInput } from "../Dataset/hooks";
 import { EChartsOption, SeriesOption } from "echarts";
 export interface IYearSerieProps {
-    dataset: string;
+    dataset: datasetInput;
     title?: string;
     yearKey: string;
     valueKey: string;

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

@@ -1,17 +1,29 @@
 import type { SelectProps } from 'antd';
 type ExtendedSelectProps = Omit<SelectProps<any>, 'options'> & {
+    /** Nom technique du controle */
+    name?: string;
+    /** Nom à afficher */
+    label?: string;
+    /** Jeu de données contenant les choix (à la place de options) */
     dataset?: string;
+    /** Choix possible */
     options?: {
         label: string;
         value: string;
     }[] | string[];
+    /** Valeur intiale sélectionnée */
     initial_value?: string;
+    /** Colonne à utiliser pour le libellé (si dataset utilisé) */
     labelField?: string;
+    /** Colonne à utiliser pour la valeur (si dataset utilisé) */
     valueField?: string;
-    name?: string;
-    label?: string;
+    /** Affichage des flèches Suivant/Précédent */
     arrows?: boolean;
+    /** Inverser le sens des flêches */
     reverse?: boolean;
 };
+/** Composant de controle permettant de choisir une valeur parmis une liste de choix.
+ * Adapté pour les choix de territoires ou d'années
+ */
 export declare const Select: React.FC<ExtendedSelectProps>;
 export {};

package/dist/components/Control/Select.js

@@ -5,6 +5,9 @@ import NextPrevSelect from '../NextPrevSelect/NextPrevSelect';
 import { list_to_options } from './Control';
 // TODO : a fusionner avec NextPrevSelect pour n'avoir qu'un seul composant
 // Actuellement, Select apporte seulement le fait de choisir les valeurs depuis un
+/** Composant de controle permettant de choisir une valeur parmis une liste de choix.
+ * Adapté pour les choix de territoires ou d'années
+ */
 export const Select = ({ name, dataset: datasetSource, options: input_options = [], labelField = 'label', valueField = 'value', arrows = false, reverse = false, label, initial_value: initial_value_in, ...rest }) => {
     const options = list_to_options(input_options);
     const data = useDataset(datasetSource)?.data;

package/dist/components/Dataset/Dataset.d.ts

@@ -1,17 +1,26 @@
 import { ReactNode } from "react";
 import { SimpleRecord } from "../..";
-import { CrudFilters, DataProvider } from "../../data_providers/types";
+import { CrudFilters } from "../../data_providers/types";
 import React from "react";
 import { ProviderType } from "./Provider";
 interface IDatasetProps {
+    /**Identifiant interne unique du jeu de données*/
     id: string;
-    provider?: DataProvider;
+    /** Url du fournisseur */
     url?: string;
-    type?: ProviderType;
+    /** Type de fournisseur */
+    type: ProviderType;
+    /** Nom de la ressource côté fournisseur
+     * (couche, dataset, fichier, etc.)
+     */
     resource: string;
+    /**
+     * ⚠️ deprecated
+     */
     filters?: CrudFilters;
     children?: ReactNode;
     pageSize?: number;
+    /** Paramètres additionnels à passer au fournisseur */
     meta?: any;
 }
 export type dataset = {
@@ -24,5 +33,8 @@ export type dataset = {
     geojson?: any;
     dataHash?: number;
 };
+/**
+ * Composant **logique** permettant de récupérer des données.
+ */
 export declare const DSL_Dataset: React.FC<IDatasetProps>;
 export {};

package/dist/components/Dataset/Dataset.js

@@ -3,14 +3,17 @@ import { useContext, useEffect } from "react";
 import { useApi } from "../..";
 import { Producer } from "./Producer";
 import React from "react";
-import { Filter, Transform, useAllControls, useAllDatasets, useDatasets } from "../../dsl";
+import { Filter, Transform, useAllDatasets, useDatasets } from "../../dsl";
 import alasql from "alasql";
 import { DataProviderContext, getProviderFromType } from "./Provider";
 import { Join } from "./Join";
 import { from } from "arquero";
 import hashCode from "../../utils/hash_data";
 import { DatasetRegistryContext } from "./context";
-export const DSL_Dataset = ({ children, id, provider: provider_input, type: providerType = 'file', url: providerUrl, resource, pageSize, meta }) => {
+/**
+ * Composant **logique** permettant de récupérer des données.
+ */
+export const DSL_Dataset = ({ children, id, type: providerType, url: providerUrl, resource, pageSize, meta }) => {
     const getTransformerFn = (component) => {
         /*
         * Génére une fonction transformer soit
@@ -57,18 +60,17 @@ export const DSL_Dataset = ({ children, id, provider: provider_input, type: prov
     };
     const datasetRegistryContext = useContext(DatasetRegistryContext);
     const allDatasets = useAllDatasets();
-    const controls = useAllControls();
     const providerContext = useContext(DataProviderContext);
-    const provider = (providerUrl && getProviderFromType(providerType)(providerUrl)) || providerContext || provider_input;
+    const provider = (providerUrl && getProviderFromType(providerType)(providerUrl)) || providerContext;
     if (provider === undefined) {
-        throw new Error("Error : No dataProvider, please use one of : <Provider> parent, providerUrl/providerType properties or provider property");
+        throw new Error("Error : No dataProvider, please use providerUrl/providerType properties");
     }
     /* Récupérer les props des filtres depuis les composants enfant Filter */
     const filters = [];
     React.Children.toArray(children)
         .filter((c) => React.isValidElement(c))
         .filter((c) => typeof c.type != 'string' && c.type.name == Filter.name).forEach((c) => {
-        const value = (typeof c.props.children === "string" ? c.props.children.trim() : c.props.children) || controls?.[c.props.control];
+        const value = (typeof c.props.children === "string" ? c.props.children.trim() : c.props.children);
         filters.push({
             operator: c.props.operator || 'eq',
             value: value,

package/dist/components/Dataset/Filter.d.ts

@@ -2,7 +2,6 @@ import { CrudOperators } from "../../data_providers/types";
 interface IFilterProps {
     field: string;
     children?: string | string[];
-    control?: string;
     operator?: Exclude<CrudOperators, "or" | "and">;
 }
 export declare const DSL_Filter: React.FC<IFilterProps>;

package/dist/components/Dataset/hooks.d.ts

@@ -1,5 +1,7 @@
 import { dataset } from "./Dataset";
-export declare const useDataset: (dataset_id?: string) => dataset | undefined;
+import { SimpleRecord } from "../..";
+export type datasetInput = string | SimpleRecord[];
+export declare const useDataset: (dataset_id?: datasetInput) => dataset | undefined;
 export declare const useAllDatasets: () => dataset[];
 export declare const useDatasets: (dataset_ids?: string[]) => dataset[];
 /**

package/dist/components/Dataset/hooks.js

@@ -1,27 +1,9 @@
 import { useCallback, useContext, useState } from "react";
 import { DatasetRegistryContext } from "./context";
-const demo_dataset = {
-    id: 'demo_dataset',
-    isError: false,
-    isFetching: false,
-    resource: 'demo_dataset',
-    data: [
-        { name: 'Mercure', type: 'Planète', satellites: 0, diameter_km: 4879 },
-        { name: 'Vénus', type: 'Planète', satellites: 0, diameter_km: 12104 },
-        { name: 'Terre', type: 'Planète', satellites: 1, diameter_km: 12742 },
-        { name: 'Mars', type: 'Planète', satellites: 2, diameter_km: 6779 },
-        { name: 'Jupiter', type: 'Planète', satellites: 79, diameter_km: 139820 },
-        { name: 'Saturne', type: 'Planète', satellites: 83, diameter_km: 116460 },
-        { name: 'Uranus', type: 'Planète', satellites: 27, diameter_km: 50724 },
-        { name: 'Neptune', type: 'Planète', satellites: 14, diameter_km: 49244 },
-        { name: 'Pluton', type: 'Planète naine', satellites: 5, diameter_km: 2370 },
-        { name: 'Cérès', type: 'Astéroïde', satellites: 0, diameter_km: 946 },
-    ]
-};
 // 🔹 Hook pour récupérer un dataset unique
 export const useDataset = (dataset_id) => {
-    if (dataset_id == 'demo_dataset') {
-        return demo_dataset;
+    if (Array.isArray(dataset_id)) { //inline dataset
+        return { data: dataset_id, isFetching: false, isError: false, resource: '', id: '' };
     }
     const datasetRegistry = useContext(DatasetRegistryContext);
     if (dataset_id) {

package/dist/components/Palette/Palette.js

@@ -2,7 +2,7 @@ import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-run
 import { Tag } from "antd";
 import chroma from "chroma-js";
 import { createContext, useContext, useEffect } from "react";
-export const DEFAULT_PALETTE = { steps: ['red', 'green', 'blue'], mode: 'hsl' };
+export const DEFAULT_PALETTE = { steps: ['#264653', '#2a9d8f', '#e9c46a', '#f4a261', '#e76f51'], mode: 'hsl' };
 export const PaletteContext = createContext({ palette: DEFAULT_PALETTE, setPalette: () => { } });
 export const usePalette = ({ nColors }) => {
     const palette_context = useContext(PaletteContext);

package/dist/dsl/index.d.ts

@@ -22,4 +22,6 @@ import { MapLayer, Map } from "../components/Map/Map";
 import { Section } from "../components/DashboardPage/Section";
 import { LegendControl } from "../components/MapLegend/MapLegend";
 import { Intro } from "../components/DashboardPage/Intro";
-export { Dashboard, Dataset, Provider, Transform, Join, Filter, Section, Intro, DataPreview, ChartEcharts, ChartPie, ChartYearSerie, Statistics, StatisticsCollection, useDataset, useDatasets, useAllDatasets, useBlockConfig, Producer, Control, useControl, useAllControls, Radio, Select, Input, Palette, usePalette, usePaletteLabels, PalettePreview, Debug, Map, MapLayer, LegendControl };
+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 };

package/dist/dsl/index.js

@@ -22,4 +22,6 @@ import { MapLayer, Map } from "../components/Map/Map";
 import { Section } from "../components/DashboardPage/Section";
 import { LegendControl } from "../components/MapLegend/MapLegend";
 import { Intro } from "../components/DashboardPage/Intro";
-export { Dashboard, Dataset, Provider, Transform, Join, Filter, Section, Intro, DataPreview, ChartEcharts, ChartPie, ChartYearSerie, Statistics, StatisticsCollection, useDataset, useDatasets, useAllDatasets, useBlockConfig, Producer, Control, useControl, useAllControls, Radio, Select, Input, Palette, usePalette, usePaletteLabels, PalettePreview, Debug, Map, MapLayer, LegendControl };
+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 };

package/dist/index.d.ts

@@ -28,5 +28,6 @@ export { WfsProvider, DatafairProvider, FileProvider };
 export type { SimpleRecord, Partner, RouteConfig } from "./types";
 export type { LegendItem } from "./components/MapLegend/MapLegend";
 export type { DashboardConfig } from "./components/Layout/DashboardApp";
+export type { datasetInput } from "./components/Dataset/hooks";
 import * as DSL from './dsl';
 export { DSL };

package/package.json

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