Skip to content

🇫🇷 Data visualization library supported by french government's design system (Système de Design de l'État)

License

MIT, Unknown licenses found

Licenses found

MIT
LICENSE
Unknown
LICENSE.md
Notifications You must be signed in to change notification settings

GouvernementFR/dsfr-chart

Repository files navigation

DSFR Chart

DSFR Chart est un module complémentaire au Système de design de l’État (DSFR) pour la visualisation de données. Il s'agit d'une bibliothèque de composants Vue.js, sous la forme de web-components, à destination des développeurs ayant besoin de graphiques pour représenter des données.

Demo

L'ensemble des graphiques disponibles sont mis en situation sur la page de demo.

Installation

L'installation de DSFR Chart peut se faire de manières différentes. En téléchargeant l'ensemble des fichiers nécessaires à son utilisation ou en utilisant le gestionnaire de paquets NPM.

Fichiers statiques

Il est possible de télécharger l'ensemble du DSFR au format zip ci-dessous. Le zip contient un ensemble de fichiers CSS et Javascript permettant l'utilisation des différents graphiques.

Vous trouverez sur la page Release de Github, toutes les sources des versions précédentes et la dernière en date.

NPM

DSFR Chart est disponible sur NPM via un ensemble de packages qu'il est possible d'ajouter directement à votre projet. Il est de ce fait nécessaire d'installer NodeJS, et d'avoir un fichier package.json à la racine de votre projet. (Il est possible d'en créer un directement via la commande npm init).

Une fois en place, il suffit d'installer le package dsfr-chart contenant l’ensemble des composants:

npm install @gouvfr/dsfr-chart

Une fois terminé dsfr-chart sera alors installé dans le dossier node_modules/dsfr-chart/

Structure de DSFR-Chart

La structure mise Ă  disposition, sur le zip ou npm est la suivante :

  • Charts : contient les fichiers js et css Ă  importer pour utiliser toutes les reprĂ©sentations disponibles.

  • Un dossier par type de reprĂ©sentation (ex : LineChart) contenant les fichiers js et css Ă  importer pour l'utilisation d'un seul type de graphique.

Configuration de votre projet

Prérequis

DSFR Chart doit être utilisé dans un projet utilisant le DSFR. Le projet doit à minima importer les feuilles css :

  • dsfr.min.css
  • icons-system.min.css (dans utility/icons/icons-system)

Il est également nécessaire de charger l'API Javascript : dsfr.module.min.js

Importation des web-components

Pour pouvoir utiliser une représentation graphique dans votre projet, il est nécessaire de charger le fichier javascript correspondant ainsi que sa feuille css associée.

Il existe deux possibilités :

  • Charger tous les composants :
<script src="./Charts/dsfr-chart.umd.js"></script>
<link rel="stylesheet" href="./Charts/dsfr-chart.css" />
  • Charger uniquement un ou plusieurs composants nĂ©cessaires (ex : ScatterChart) :
<script src="./ScatterChart/scatter-chart.umd.js"></script>
<link rel="stylesheet" href="./ScatterChart/scatter-chart.css" />

Fonctionnement

Les différentes représentations graphiques

Introduction DSFR Chart

Ce catalogue présente l'ensemble des graphiques disponibles dans le module complémentaire au Système de design de l'État (DSFR) pour la visualisation de données. Les différents types de graphiques sont disponibles en thème clair et thème sombre. Par ailleurs, les options de chacun des graphiques sont également présentés dans ce document.

I. Nuage de points / ScatterChart

Les nuages de points sont accessibles Ă  travers la balise : <scatter-chart>.

Paramètres

Obligatoires :

  • x : (String) Les valeurs sur l'axe des abscisses sous forme d'une liste de listes entre crochets.
  • y : (String) Les valeurs sur l'axe des ordonnĂ©es sous forme d'une liste de listes entre crochets.

Optionnels :

  • selectedPalette : (String) Permet de choisir la palette de couleurs utilisĂ©e pour le graphique. Les valeurs possibles sont :

    • 'categorical' : Palette catĂ©gorielle par dĂ©faut.
    • 'sequentialAscending' : Palette sĂ©quentielle ascendante.
    • 'sequentialDescending' : Palette sĂ©quentielle descendante.
    • 'divergentAscending' : Palette divergente ascendante.
    • 'divergentDescending' : Palette divergente descendante.
    • 'neutral' : Palette neutre.
    • 'defaultColor' : Couleur par dĂ©faut.
    • (laisser vide pour utiliser la palette par dĂ©faut)
  • highlightIndex : (Number | Array) Index ou liste d'index des points Ă  mettre en avant (utilisĂ© principalement avec la palette 'neutral').

  • showline : (Boolean) Permet de relier les points du nuage. Mettre Ă  true pour afficher les lignes entre les points.


Exemples

1. Nuage de points simple

Exemple:

<scatter-chart x="[[1, 5, 8]]" y="[[30, 10, 20]]"></scatter-chart>

2. Nuage de points reliés

On peut choisir de relier les points d'un ScatterChart avec l'option showline. On lui affecte la valeur true dans le cas où l’on veut relier les points.

Exemple:

<scatter-chart
  x="[[1, 5, 8]]"
  y="[[30, 10, 20]]"
  showline="true"
></scatter-chart>

3. Nuage de points avec palette divergente ascendante

Vous pouvez spécifier une palette de couleurs pour le graphique en utilisant le paramètre selectedPalette.

Exemple:

<scatter-chart
  x="[[1, 5, 8], [2, 6, 9]]"
  y="[[30, 10, 20], [15, 25, 35]]"
  selectedPalette="divergentAscending"
></scatter-chart>

4. Nuage de points avec mise en avant de points spécifiques

Pour mettre en avant des points spécifiques, utilisez la palette 'neutral' et spécifiez les index des points à mettre en avant avec highlightIndex.

Exemple:

<scatter-chart
  x="[[1, 5, 8]]"
  y="[[30, 10, 20]]"
  selectedPalette="neutral"
  highlightIndex="[1, 2]"
></scatter-chart>

5. Nuage de points avec lignes et mise en avant

Il est possible de combiner plusieurs options pour personnaliser davantage votre graphique.

Exemple:

<scatter-chart
  x="[[1, 3, 5, 7]]"
  y="[[10, 20, 15, 25]]"
  showline="true"
  selectedPalette="neutral"
  highlightIndex="[2]"
></scatter-chart>

Notes supplémentaires

  • selectedPalette : Ce paramètre vous permet de personnaliser les couleurs utilisĂ©es dans le graphique. Les diffĂ©rentes options vous offrent une flexibilitĂ© pour reprĂ©senter vos donnĂ©es selon vos besoins esthĂ©tiques ou sĂ©mantiques.
  • highlightIndex : En combinaison avec la palette 'neutral', ce paramètre vous permet de mettre en avant des points spĂ©cifiques du graphique. Les index commencent Ă  0.
  • showline : Utile pour visualiser les tendances ou les relations entre les points en les reliant par des lignes.

II. Graphique en lignes (LineChart)

Les graphiques en lignes sont accessibles Ă  travers la balise : <line-chart>.

Paramètres

Obligatoires :

  • x : (String) Les valeurs sur l'axe des abscisses sous forme d'une liste entre crochets.
  • y : (String) Les valeurs sur l'axe des ordonnĂ©es sous forme d'une liste entre crochets.

Optionnels :

  • selectedPalette : (String) Permet de choisir la palette de couleurs utilisĂ©e pour le graphique. Les valeurs possibles sont :

    • 'categorical' : Palette catĂ©gorielle par dĂ©faut.
    • 'sequentialAscending' : Palette sĂ©quentielle ascendante.
    • 'sequentialDescending' : Palette sĂ©quentielle descendante.
    • 'divergentAscending' : Palette divergente ascendante.
    • 'divergentDescending' : Palette divergente descendante.
    • 'neutral' : Palette neutre.
    • 'defaultColor' : Couleur par dĂ©faut.
    • (laisser vide pour utiliser la palette par dĂ©faut)
  • highlightIndex : (Number | Array) Index ou liste d'index des points Ă  mettre en avant (utilisĂ© principalement avec la palette 'neutral').

  • unitTooltip : (String) Permet de spĂ©cifier l'unitĂ© Ă  afficher dans l'infobulle (tooltip) du graphique. Par exemple, %, €, $, etc.


1. Graphique en lignes simple

Exemple:

<line-chart x="[1, 2, 3, 4]" y="[10, 20, 30, 40]" unit-tooltip="%"></line-chart>

2. Graphique en lignes avec palette divergente ascendante

Exemple:

<line-chart
  x="[1, 2, 3, 4]"
  y="[10, 20, 30, 40]"
  selectedPalette="divergentAscending"
></line-chart>

3. Graphique en lignes avec mise en avant de points spécifiques

Exemple:

<line-chart
  x="[1, 2, 3, 4]"
  y="[10, 20, 30, 40]"
  selectedPalette="neutral"
  highlightIndex="[2]"
></line-chart>

4. Graphique en lignes avec unité personnalisée dans l'infobulle

Exemple:

<line-chart
  x="[1, 2, 3, 4]"
  y="[1000, 2000, 3000, 4000]"
  unit-tooltip="€"
></line-chart>

Notes supplémentaires

  • selectedPalette : Ce paramètre vous permet de personnaliser les couleurs utilisĂ©es dans le graphique. Choisissez parmi les options disponibles pour reprĂ©senter vos donnĂ©es de manière appropriĂ©e.
  • highlightIndex : UtilisĂ© en combinaison avec la palette 'neutral', ce paramètre vous permet de mettre en avant des points spĂ©cifiques du graphique. Les index commencent Ă  0.
  • unitTooltip : Ce paramètre vous permet de spĂ©cifier l'unitĂ© qui sera affichĂ©e dans l'infobulle (tooltip) lorsque l'utilisateur survole un point du graphique. Cela rend la lecture des valeurs plus intuitive en indiquant l'unitĂ© de mesure.

Conseils d'utilisation

  • Format des donnĂ©es : Assurez-vous que les valeurs de x et y sont des chaĂ®nes reprĂ©sentant des listes, par exemple x="[1, 2, 3]".
  • Combinaison des options : Vous pouvez combiner plusieurs options pour personnaliser davantage votre graphique, par exemple en utilisant selectedPalette avec highlightIndex et unitTooltip.
  • Indexation : Les index utilisĂ©s dans highlightIndex correspondent aux positions des points dans vos donnĂ©es y. Par exemple, highlightIndex="[0]" mettra en avant le premier point.

Exemple combinant plusieurs options

Exemple:

<line-chart
  x="[1, 2, 3, 4, 5]"
  y="[15, 25, 35, 45, 55]"
  selectedPalette="neutral"
  highlightIndex="[2, 4]"
  unit-tooltip="kWh"
></line-chart>

II. Graphique en multilignes (ou LineChart multiples)

Les graphiques en multilignes (ou LineChart multiples) sont accessibles Ă  travers la balise : <multi-line-chart>.

Paramètres

Obligatoires :

  • x : (String) Les valeurs sur l'axe des abscisses sous forme d'une liste de listes entre crochets.
  • y : (String) Les valeurs sur l'axe des ordonnĂ©es sous forme d'une liste de listes entre crochets.

Optionnels :

  • selectedPalette : (String) Permet de choisir la palette de couleurs utilisĂ©e pour le graphique. Les valeurs possibles sont :

    • 'categorical' : Palette catĂ©gorielle par dĂ©faut.
    • 'sequentialAscending' : Palette sĂ©quentielle ascendante.
    • 'sequentialDescending' : Palette sĂ©quentielle descendante.
    • 'divergentAscending' : Palette divergente ascendante.
    • 'divergentDescending' : Palette divergente descendante.
    • 'neutral' : Palette neutre.
    • 'defaultColor' : Couleur par dĂ©faut.
    • (laisser vide pour utiliser la palette par dĂ©faut)
  • unitTooltip : (String) Permet de spĂ©cifier l'unitĂ© Ă  afficher dans l'infobulle (tooltip) du graphique. Par exemple, %, €, $, etc.


Exemple:

<multiline-chart
  x="[[1, 2, 3], [1, 2, 3]]"
  y="[[30, 10, 20], [10, 20, 30]]"
  selectedPalette="divergentAscending"
  unit-tooltip="%"
></multiline-chart>

Notes supplémentaires

  • selectedPalette : Ce paramètre vous permet de personnaliser les couleurs utilisĂ©es pour chaque ligne du graphique. Les diffĂ©rentes options vous offrent une flexibilitĂ© pour reprĂ©senter vos donnĂ©es selon vos besoins esthĂ©tiques ou sĂ©mantiques.
  • unitTooltip : Ce paramètre vous permet de spĂ©cifier l'unitĂ© qui sera affichĂ©e dans l'infobulle (tooltip) lorsque l'utilisateur survole un point du graphique. Cela rend la lecture des valeurs plus intuitive en indiquant l'unitĂ© de mesure.

Autres exemples

1. Multilignes avec palette séquentielle ascendante et unité personnalisée

Exemple:

<multiline-chart
  x="[[1, 2, 3], [1, 2, 3]]"
  y="[[100, 200, 300], [150, 250, 350]]"
  selectedPalette="sequentialAscending"
  unit-tooltip="€"
></multiline-chart>

2. Multilignes avec palette neutre

Exemple:

<multiline-chart
  x="[[1, 2, 3], [1, 2, 3]]"
  y="[[5, 15, 25], [10, 20, 30]]"
  selectedPalette="neutral"
></multiline-chart>

Conseils d'utilisation

  • Format des donnĂ©es : Assurez-vous que les valeurs de x et y sont des chaĂ®nes reprĂ©sentant des listes de listes, par exemple x="[[1, 2, 3], [1, 2, 3]]".
  • Combinaison des options : Vous pouvez combiner les options selectedPalette et unitTooltip pour personnaliser davantage votre graphique.
  • Personnalisation des sĂ©ries : Chaque sĂ©rie de donnĂ©es sera reprĂ©sentĂ©e par une ligne distincte. Les couleurs des lignes seront attribuĂ©es en fonction de la palette sĂ©lectionnĂ©e.

III. Diagramme en barres (BarChart)

Les graphiques en barres sont accessibles Ă  travers la balise : <bar-chart>.

Paramètres

Obligatoires :

  • x : (String) Les valeurs sur l’axe des abscisses sous forme d’une liste de listes entre crochets.
  • y : (String) Les valeurs sur l’axe des ordonnĂ©es sous forme d’une liste de listes entre crochets.

Optionnels :

  • name : (String) Les noms des sĂ©ries de donnĂ©es sous forme d'une liste entre crochets.

  • selectedPalette : (String) Permet de choisir la palette de couleurs utilisĂ©e pour le graphique. Les valeurs possibles sont :

    • 'categorical' : Palette catĂ©gorielle par dĂ©faut.
    • 'sequentialAscending' : Palette sĂ©quentielle ascendante.
    • 'sequentialDescending' : Palette sĂ©quentielle descendante.
    • 'divergentAscending' : Palette divergente ascendante.
    • 'divergentDescending' : Palette divergente descendante.
    • 'neutral' : Palette neutre.
    • 'defaultColor' : Couleur par dĂ©faut.
    • (laisser vide pour utiliser la palette par dĂ©faut)
  • highlightIndex : (Array) Liste d'index des barres Ă  mettre en avant (utilisĂ© principalement avec la palette 'neutral').

  • isDescendingOrder : (Boolean) Permet d'inverser l'ordre des couleurs dans la lĂ©gende et le graphique pour certaines palettes. Mettre Ă  true pour inverser l'ordre, par exemple pour afficher une progression de vert Ă  rouge.

  • unitTooltip : (String) Permet de spĂ©cifier l'unitĂ© Ă  afficher dans l'infobulle (tooltip) du graphique. Par exemple, %, €, $, etc.

  • horizontal : (Boolean) Permet d'afficher le graphique en barres horizontales. Mettre Ă  true pour activer.

  • stacked : (Boolean) Permet d'empiler les barres pour afficher des donnĂ©es empilĂ©es. Mettre Ă  true pour activer.


1. Barres verticales simples

Exemple:

<bar-chart
  x='[["2025", "2030", "2035", "2040", "2050", "2060", "2070"]]'
  y="[[69.1, 70.3, 71.4, 72.5, 74, 75.2, 76.4]]"
  name='["Population en millions"]'
  selected-palette="defaultColor"
  unit-tooltip="millions"
></bar-chart>

2. Barres horizontales

Pour tracer un BarChart horizontal, il faut renseigner l’option horizontal="true".

Exemple:

<bar-chart
  x='[["2025", "2030", "2035", "2040"]]'
  y="[[10, 20, 30, 40]]"
  horizontal="true"
  selected-palette="categorical"
></bar-chart>

3. Barres empilées

Pour tracer un BarChart empilé, il faut renseigner l’option stacked="true".

Exemple:

<bar-chart
  x='[["Catégorie A", "Catégorie B", "Catégorie C", "Catégorie D"]]'
  y="[[15, 19, 15, 13], [45, 40, 47, 41], [36, 32, 34, 44], [4, 9, 4, 2]]"
  name='["SĂ©rie 1", "SĂ©rie 2", "SĂ©rie 3", "SĂ©rie 4"]'
  stacked="true"
  selected-palette="divergentDescending"
  :isDescendingOrder="true"
  unit-tooltip="%"
></bar-chart>

4. Barres avec mise en avant de certaines catégories

Utilisez highlightIndex pour mettre en avant certaines barres, en combinaison avec selectedPalette="neutral".

Exemple:

<bar-chart
  x='[["Jan", "Feb", "Mar", "Apr", "May", "Jun"]]'
  y="[[5, 10, 15, 20, 25, 30]]"
  selected-palette="neutral"
  :highlightIndex="[2, 4]"
  unit-tooltip="k€"
></bar-chart>

5. Barres avec palette séquentielle ascendante

Exemple:

<bar-chart
  x='[["Q1", "Q2", "Q3", "Q4"]]'
  y="[[200, 400, 600, 800]]"
  selected-palette="sequentialAscending"
  unit-tooltip="units"
></bar-chart>

Notes supplémentaires

  • selectedPalette : Ce paramètre vous permet de personnaliser les couleurs utilisĂ©es dans le graphique. Choisissez parmi les options disponibles pour reprĂ©senter vos donnĂ©es de manière appropriĂ©e.
  • highlightIndex : UtilisĂ© en combinaison avec la palette 'neutral', ce paramètre vous permet de mettre en avant des barres spĂ©cifiques du graphique. Les index commencent Ă  0.
  • isDescendingOrder : Ce paramètre est particulièrement utile avec les palettes divergentes pour inverser l'ordre des couleurs, par exemple pour reprĂ©senter une progression du vert au rouge.
  • unitTooltip : Ce paramètre vous permet de spĂ©cifier l'unitĂ© qui sera affichĂ©e dans l'infobulle (tooltip) lorsque l'utilisateur survole une barre du graphique. Cela rend la lecture des valeurs plus intuitive en indiquant l'unitĂ© de mesure.
  • horizontal : DĂ©finit l'orientation du graphique. Par dĂ©faut, les barres sont verticales.
  • stacked : Permet d'empiler les sĂ©ries de donnĂ©es, utile pour visualiser la contribution de chaque sĂ©rie au total.

Conseils d'utilisation

  • Format des donnĂ©es : Assurez-vous que les valeurs de x et y sont des chaĂ®nes reprĂ©sentant des listes de listes, par exemple x='[["Label1", "Label2"]]' et y='[[10, 20], [30, 40]]'.
  • Combinaison des options : Vous pouvez combiner plusieurs options pour personnaliser davantage votre graphique, comme utiliser horizontal="true" avec stacked="true".
  • Indexation : Les index utilisĂ©s dans highlightIndex correspondent aux positions des barres dans vos donnĂ©es x. Par exemple, :highlightIndex="[0, 2]" mettra en avant la première et la troisième barre.
  • Dynamique des couleurs : En utilisant isDescendingOrder, vous pouvez contrĂ´ler l'ordre des couleurs dans la lĂ©gende et le graphique, ce qui peut ĂŞtre utile pour reprĂ©senter des donnĂ©es oĂą l'ordre des couleurs a une signification.

Exemple combinant plusieurs options

Exemple:

<bar-chart
  x='[["Produit A", "Produit B", "Produit C", "Produit D"]]'
  y="[[50, 70, 30, 90]]"
  name='["Ventes"]'
  selected-palette="neutral"
  :highlightIndex="[3]"
  horizontal="true"
  unit-tooltip="k€"
></bar-chart>

V. Options de lignes verticales et horizontales

Sur tous les graphiques présentés ci-dessus, il est possible d'ajouter des lignes verticales et horizontales pour mettre en évidence des seuils ou des valeurs spécifiques.

Paramètres

Optionnels :

  • vline : (String) Les positions des lignes verticales sur l’axe des abscisses sous forme d’une liste entre crochets.
  • vlinename : (String) Les noms des lignes verticales sous forme d’une liste entre crochets.
  • vlinecolor : (String) Les couleurs des lignes verticales sous forme d’une liste entre crochets. Vous pouvez utiliser les noms de couleurs prĂ©dĂ©finies ou des codes hexadĂ©cimaux.
  • hline : (String) Les positions des lignes horizontales sur l’axe des ordonnĂ©es sous forme d’une liste entre crochets.
  • hlinename : (String) Les noms des lignes horizontales sous forme d’une liste entre crochets.
  • hlinecolor : (String) Les couleurs des lignes horizontales sous forme d’une liste entre crochets. Vous pouvez utiliser les noms de couleurs prĂ©dĂ©finies ou des codes hexadĂ©cimaux.
  • selectedPalette : (String) Permet de choisir la palette de couleurs utilisĂ©e pour le graphique principal (barres et lignes). Les valeurs possibles sont les mĂŞmes que prĂ©cĂ©demment.
  • unitTooltip : (String) Permet de spĂ©cifier l'unitĂ© Ă  afficher dans l'infobulle (tooltip) du graphique.

Exemple :

<line-chart
  x="[1, 2, 3]"
  y="[10, 20, 30]"
  hline="[15, 25]"
  hlinename='["hmin", "hmax"]'
  vline="[1.6, 2.3]"
  vlinename='["vmin","vmax"]'
  vlinecolor='["green-archipel", "orange-terre-battue"]'
  hlinecolor='["blue-ecume", "red-marianne"]'
  selectedPalette="categorical"
  unit-tooltip="units"
></line-chart>

Notes supplémentaires

  • vline et hline : Ces paramètres permettent d'ajouter des lignes de rĂ©fĂ©rence verticales et horizontales sur le graphique. Les valeurs doivent ĂŞtre des nombres correspondant aux positions sur les axes.
  • vlinename et hlinename : Vous pouvez fournir des noms pour ces lignes qui seront affichĂ©s sur le graphique.
  • vlinecolor et hlinecolor : SpĂ©cifiez les couleurs des lignes de rĂ©fĂ©rence. Vous pouvez utiliser les noms de couleurs prĂ©dĂ©finies du thème ou des codes hexadĂ©cimaux (par exemple, "#FF5733").
  • selectedPalette : Comme prĂ©cĂ©demment, ce paramètre vous permet de personnaliser les couleurs du graphique principal.
  • unitTooltip : SpĂ©cifiez l'unitĂ© Ă  afficher dans l'infobulle du graphique principal. Les infobulles des lignes de rĂ©fĂ©rence ne sont gĂ©nĂ©ralement pas affectĂ©es par ce paramètre.

Conseils d'utilisation

  • Correspondance des listes : Assurez-vous que les listes pour les positions, les noms et les couleurs des lignes ont le mĂŞme nombre d'Ă©lĂ©ments.

    • Par exemple, si vous avez deux valeurs dans hline, vous devez avoir deux valeurs dans hlinename et hlinecolor.
  • Personnalisation des couleurs : Si vous n'indiquez pas de couleurs spĂ©cifiques pour les lignes, des couleurs par dĂ©faut seront utilisĂ©es.

  • Visualisation des seuils : L'ajout de lignes de rĂ©fĂ©rence est utile pour visualiser des seuils, des moyennes ou d'autres valeurs importantes sur le graphique.


Exemple combinant plusieurs options

Exemple :

<bar-line-chart
  x="[1, 2, 3, 4, 5]"
  y="[20, 25, 30, 35, 40]"
  ybar="[15, 18, 22, 28, 33]"
  hline="[25]"
  hlinename='["Moyenne"]'
  hlinecolor='["#FF0000"]'
  vline="[3]"
  vlinename='["Point Milieu"]'
  vlinecolor='["#0000FF"]'
  selectedPalette="sequentialAscending"
  unit-tooltip="kW"
></bar-line-chart>

VI. Diagramme circulaire (PieChart)

Les diagrammes circulaires (ou PieChart) sont accessibles Ă  travers la balise : <pie-chart>.

Paramètres

Obligatoires :

  • x : (String) Les noms de chaque groupe sous la forme d’une liste entre crochets.
  • y : (String) Les valeurs de chaque groupe sous la forme d’une liste entre crochets.

Optionnels :

  • name : (String) Les noms des sĂ©ries de donnĂ©es sous forme d'une liste entre crochets.

  • selectedPalette : (String) Permet de choisir la palette de couleurs utilisĂ©e pour le graphique. Les valeurs possibles sont :

    • 'categorical' : Palette catĂ©gorielle par dĂ©faut.
    • 'sequentialAscending' : Palette sĂ©quentielle ascendante.
    • 'sequentialDescending' : Palette sĂ©quentielle descendante.
    • 'divergentAscending' : Palette divergente ascendante.
    • 'divergentDescending' : Palette divergente descendante.
    • 'neutral' : Palette neutre.
    • 'defaultColor' : Couleur par dĂ©faut.
    • (laisser vide pour utiliser la palette par dĂ©faut)
  • unitTooltip : (String) Permet de spĂ©cifier l'unitĂ© Ă  afficher dans l'infobulle (tooltip) du graphique. Par exemple, %, €, $, etc.

  • fill : (Boolean) Permet de remplir l’intĂ©rieur du graphique. Mettre Ă  true pour un diagramme circulaire plein.


1. Diagramme circulaire creux (donut)

Exemple :

<pie-chart
  x='["Non-salariés", "Emplois à durée indéterminée", "Contrats à durée déterminée", "Apprentis", "Intérimaires"]'
  y="[11.7, 74.8, 9.3, 1.6, 2.6]"
  name='["Non-salariés", "Emplois à durée indéterminée", "Contrats à durée déterminée", "Apprentis", "Intérimaires"]'
  unit-tooltip="%"
  selectedPalette="categorical"
></pie-chart>

2. Diagramme circulaire plein

L’option fill="true" permet de remplir l’intérieur du graphique pour obtenir un diagramme circulaire plein.

Exemple :

<pie-chart
  x='["Groupe A", "Groupe B", "Groupe C"]'
  y="[10, 20, 30]"
  fill="true"
  unit-tooltip="%"
  selectedPalette="divergentAscending"
></pie-chart>

Notes supplémentaires

  • selectedPalette : Ce paramètre vous permet de personnaliser les couleurs utilisĂ©es dans le graphique. Choisissez parmi les options disponibles pour reprĂ©senter vos donnĂ©es de manière appropriĂ©e.
  • unitTooltip : Ce paramètre vous permet de spĂ©cifier l'unitĂ© qui sera affichĂ©e dans l'infobulle (tooltip) lorsque l'utilisateur survole une portion du diagramme. Cela rend la lecture des valeurs plus intuitive en indiquant l'unitĂ© de mesure.
  • fill : Par dĂ©faut, le PieChart est affichĂ© sous forme de donut (creux au centre). En dĂ©finissant fill="true", vous obtiendrez un diagramme circulaire plein.

Conseils d'utilisation

  • Format des donnĂ©es : Assurez-vous que les valeurs de x et y sont des chaĂ®nes reprĂ©sentant des listes, par exemple x='["Groupe A", "Groupe B"]'.
  • Combinaison des options : Vous pouvez combiner plusieurs options pour personnaliser davantage votre graphique, comme utiliser fill="true" avec selectedPalette.
  • Personnalisation des sĂ©ries : Le paramètre name peut ĂŞtre utilisĂ© pour spĂ©cifier des noms de sĂ©ries personnalisĂ©s.

Exemple combinant plusieurs options

<pie-chart
  x='["Catégorie 1", "Catégorie 2", "Catégorie 3"]'
  y="[40, 35, 25]"
  fill="true"
  unit-tooltip="€"
  selectedPalette="sequentialDescending"
></pie-chart>

VII. Diagramme en Ă©toile (RadarChart)

Les diagrammes en Ă©toile (ou RadarChart) sont accessibles Ă  travers la balise : <radar-chart>.

Paramètres

Obligatoires :

  • x : (String) Les noms de chaque groupe sous la forme d’une liste de listes entre crochets.

  • y : (String) Les valeurs de chaque groupe sous la forme d’une liste de listes entre crochets.

Optionnels :

  • name : (String) Les noms des sĂ©ries de donnĂ©es sous forme d'une liste entre crochets.

  • selectedPalette : (String) Permet de choisir la palette de couleurs utilisĂ©e pour le graphique. Les valeurs possibles sont :

    • 'categorical' : Palette catĂ©gorielle par dĂ©faut.
    • 'sequentialAscending' : Palette sĂ©quentielle ascendante.
    • 'sequentialDescending' : Palette sĂ©quentielle descendante.
    • 'divergentAscending' : Palette divergente ascendante.
    • 'divergentDescending' : Palette divergente descendante.
    • 'neutral' : Palette neutre.
    • 'defaultColor' : Couleur par dĂ©faut.
    • (laisser vide pour utiliser la palette par dĂ©faut)
  • unitTooltip : (String) Permet de spĂ©cifier l'unitĂ© Ă  afficher dans l'infobulle (tooltip) du graphique. Par exemple, %, €, $, etc.


Exemple :

<radar-chart
  x='[["Non-salariés", "Emplois à durée indéterminée", "Contrats à durée déterminée", "Apprentis", "Intérimaires"]]'
  y="[[2.4, 43.9, 28.5, 17.2, 8.0],
      [10.6, 77.8, 8.8, 0.2, 2.6],
      [16.5, 77.3, 4.9, 0.0, 1.3]]"
  name='["15-24 ans", "25-49 ans", "50-64 ans"]'
  selectedPalette="categorical"
  unit-tooltip="%"
>
</radar-chart>

Notes supplémentaires

  • selectedPalette : Ce paramètre vous permet de personnaliser les couleurs utilisĂ©es dans le graphique. Choisissez parmi les options disponibles pour reprĂ©senter vos donnĂ©es de manière appropriĂ©e.

  • unitTooltip : Ce paramètre vous permet de spĂ©cifier l'unitĂ© qui sera affichĂ©e dans l'infobulle (tooltip) lorsque l'utilisateur survole une valeur du graphique. Cela rend la lecture des valeurs plus intuitive en indiquant l'unitĂ© de mesure.


Conseils d'utilisation

  • Format des donnĂ©es : Assurez-vous que les valeurs de x et y sont des chaĂ®nes reprĂ©sentant des listes de listes. Par exemple :

    • Pour x : x='[["Label1", "Label2", "Label3"]]'
    • Pour y : y='[[10, 20, 30], [15, 25, 35]]'
  • Combinaison des options : Vous pouvez combiner plusieurs options pour personnaliser davantage votre graphique, comme utiliser selectedPalette avec unitTooltip.

  • Personnalisation des sĂ©ries : Le paramètre name est utilisĂ© pour spĂ©cifier les noms des sĂ©ries de donnĂ©es. Si vous avez plusieurs sĂ©ries (plusieurs listes dans y), vous devez fournir une liste de noms correspondante dans name.


Autres exemples

1. Diagramme en Ă©toile avec palette divergente ascendante

Exemple :

<radar-chart
  x='[["Critère 1", "Critère 2", "Critère 3", "Critère 4", "Critère 5"]]'
  y="[[80, 90, 70, 60, 50], [60, 70, 80, 90, 100]]"
  name='["SĂ©rie A", "SĂ©rie B"]'
  selectedPalette="divergentAscending"
  unit-tooltip="%"
>
</radar-chart>

2. Diagramme en étoile avec unité personnalisée

Exemple :

<radar-chart
  x='[["Vitesse", "Puissance", "Agilité", "Endurance", "Précision"]]'
  y="[[85, 90, 75, 80, 70]]"
  name='["Athlète 1"]'
  unit-tooltip="points"
>
</radar-chart>

VIII. Jauges (ou GaugeChart)

Ce graphique est généré avec la balise <gauge-chart>

Les paramètres obligatoires sont :

· value : la valeur actuelle de la jauge sous la forme d’une un nombre

· init : la valeur de départ de la jauge

· target : la valeur cible de la jauge

Exemple :

<gauge-chart value="16" init="10" target="20" color="blue-france"></gauge-chart>

IX. Cartes (MapChart)

Les cartes sont accessibles Ă  travers la balise : <map-chart>.

Paramètres

Obligatoires :

  • data : (String) Un dictionnaire qui, pour chaque numĂ©ro de dĂ©partement ou de rĂ©gion, associe la valeur de l’indicateur dans cette zone gĂ©ographique.

  • valuenat : (String | Number) La valeur de l'indicateur Ă  l'Ă©chelle nationale. Cette valeur sera affichĂ©e dans la barre latĂ©rale.

  • name : (String) Nom de l'indicateur.

Optionnels :

  • level : (String) Choix du niveau de zoom. Les valeurs possibles sont :

    • 'dep' : Carte avec dĂ©coupage par dĂ©partements (par dĂ©faut).
    • 'reg' : Carte avec dĂ©coupage par rĂ©gions.
  • selectedPalette : (String) Permet de choisir la palette de couleurs utilisĂ©e pour la carte. Les valeurs possibles sont :

    • 'categorical'
    • 'sequentialAscending' (par dĂ©faut)
    • 'sequentialDescending'
    • 'divergentAscending'
    • 'divergentDescending'
    • 'neutral'
    • (laisser vide pour utiliser la palette par dĂ©faut)
  • highlightIndex : (Number | String | Array) Code ou liste des codes gĂ©ographiques Ă  mettre en avant sur la carte. Si aucune donnĂ©e n'est mise en avant, toutes les zones sont affichĂ©es avec la couleur neutre. Par dĂ©faut, -1 signifie aucune mise en avant.


Exemples

1. Carte avec découpage par départements

Exemple :

<map-chart
  data='{
    "01": 72, "02": 83, "03": 67, "04": 36, "05": 47, "06": 96, "07": 77, "08": 75, "09": 57, "10": 58,
    "11": 38, "12": 33, "13": 89, "14": 24, "15": 52, "16": 41, "17": 79, "18": 38, "19": 42, "21": 25,
    "22": 26, "23": 37, "24": 65, "25": 88, "26": 48, "27": 61, "28": 80, "29": 12, "30": 6, "31": 5,
    "32": 22, "33": 40, "34": 19, "35": 13, "36": 32, "37": 0, "38": 82, "39": 13, "40": 78, "41": 92,
    "42": 10, "43": 22, "44": 70, "45": 85, "46": 58, "47": 72, "48": 61, "49": 27, "50": 47, "51": 41,
    "52": 44, "53": 29, "54": 22, "55": 4, "56": 57, "57": 94, "58": 46, "59": 33, "60": 0, "61": 15,
    "62": 60, "63": 71, "64": 0, "65": 91, "66": 51, "67": 56, "68": 19, "69": 44, "70": 92, "71": 96,
    "72": 51, "73": 32, "74": 19, "75": 96, "76": 91, "77": 21, "78": 48, "79": 72, "80": 52, "81": 48,
    "82": 57, "83": 38, "84": 23, "85": 46, "86": 37, "87": 64, "88": 78, "89": 100, "90": 85, "91": 87,
    "92": 46, "93": 89, "94": 18, "95": 72, "971": 48, "972": 28, "973": 35, "974": 70, "976": 38, "2A": 63,
    "2B": 16
  }'
  valuenat="10"
  name="Nom de l'indicateur"
  selected-palette="sequentialAscending"
  :highlightIndex='["75", "13"]'
></map-chart>

2. Carte avec découpage par régions

Exemple :

<map-chart
  data='{
    "84": 1, "32": 10, "93": 20, "44": 30, "76": 40, "28": 50, "75": 60, "24": 70, "53": 80, "94": 90,
    "52": 100, "01": 95, "02": 85, "03": 75, "04": 65, "06": 55, "27": 100, "11": 35
  }'
  valuenat="10"
  name="Nom de l'indicateur"
  level="reg"
  selected-palette="divergentDescending"
  :highlightIndex='["84", "93"]'
></map-chart>

3. Carte régionale détaillée (MapChart-reg)

Les cartes par région sont accessibles à travers la balise : <map-chart-reg>.

Paramètres spécifiques :

  • data : (String) Un dictionnaire qui, pour chaque numĂ©ro de dĂ©partement, associe la valeur de l’indicateur dans ce dĂ©partement.

  • valuereg : (String | Number) La valeur de l'indicateur Ă  l'Ă©chelle rĂ©gionale. Cette valeur sera affichĂ©e dans la barre latĂ©rale.

  • name : (String) Nom de l'indicateur.

  • region : (String) Code de la rĂ©gion Ă  afficher.

  • selectedPalette : (String) Palette de couleurs utilisĂ©e pour la carte (identique Ă  MapChart).

  • highlightIndex : (Number | String | Array) Code ou liste des codes des dĂ©partements Ă  mettre en avant.

Exemple :

<map-chart-reg
  data='{
    "01": 72, "02": 83, "03": 67, "04": 36, "05": 47, "06": 96, "07": 77, "08": 75, "09": 57, "10": 58,
    "11": 38, "12": 33, "13": 89, "14": 24, "15": 52, "16": 41, "17": 79, "18": 38, "19": 42, "21": 25,
    "22": 26, "23": 37, "24": 65, "25": 88, "26": 48, "27": 61, "28": 80, "29": 12, "30": 6, "31": 5,
    "32": 22, "33": 40, "34": 19, "35": 13, "36": 32, "37": 0, "38": 82, "39": 13, "40": 78, "41": 92,
    "42": 10, "43": 22, "44": 70, "45": 85, "46": 58, "47": 72, "48": 61, "49": 27, "50": 47, "51": 41,
    "52": 44, "53": 29, "54": 22, "55": 4, "56": 57, "57": 94, "58": 46, "59": 33, "60": 0, "61": 15,
    "62": 60, "63": 71, "64": 0, "65": 91, "66": 51, "67": 56, "68": 19, "69": 44, "70": 92, "71": 96,
    "72": 51, "73": 32, "74": 19, "75": 96, "76": 91, "77": 21, "78": 48, "79": 72, "80": 52, "81": 48,
    "82": 57, "83": 38, "84": 23, "85": 46, "86": 37, "87": 64, "88": 78, "89": 100, "90": 85, "91": 87,
    "92": 46, "93": 89, "94": 18, "95": 72, "971": 48, "972": 28, "973": 35, "974": 70, "976": 38, "2A": 63,
    "2B": 16
  }'
  valuereg="10"
  name="Nom de l'indicateur"
  region="93"
  selected-palette="categorical"
  :highlightIndex='["93", "84"]'
></map-chart-reg>

Notes supplémentaires

  • selectedPalette : Ce paramètre vous permet de personnaliser les couleurs utilisĂ©es sur la carte. Les palettes disponibles permettent de reprĂ©senter les donnĂ©es selon diffĂ©rentes Ă©chelles de couleurs.

  • highlightIndex : Vous pouvez mettre en avant certaines zones gĂ©ographiques en spĂ©cifiant leurs codes dans une liste. Les zones mises en avant seront affichĂ©es avec une couleur diffĂ©rente pour attirer l'attention.

  • level : Par dĂ©faut, la carte affiche le dĂ©coupage par dĂ©partements ('dep'). En spĂ©cifiant level="reg", vous pouvez afficher la carte avec le dĂ©coupage par rĂ©gions.


Conseils d'utilisation

  • Format des donnĂ©es : Les clĂ©s du dictionnaire data doivent correspondre aux codes des dĂ©partements ou rĂ©gions (par exemple, "75" pour Paris, "84" pour la rĂ©gion Auvergne-RhĂ´ne-Alpes).

  • Combinaison des options : Vous pouvez combiner plusieurs options pour personnaliser votre carte, comme utiliser selectedPalette avec highlightIndex.

  • Personnalisation des couleurs : Si vous souhaitez mettre en avant certaines zones, utilisez le paramètre highlightIndex en combinaison avec une palette appropriĂ©e.


Exemple combinant plusieurs options

Exemple :

<map-chart
  data='{"01": 72, "02": 83, "03": 67, "04": 36, "05": 47}'
  valuenat="65"
  name="Taux de réussite"
  selected-palette="neutral"
  :highlightIndex='["01", "02"]'
  level="dep"
></map-chart>

Résumé des paramètres de MapChart

paramètre type obligatoire description
data string oui dictionnaire associant les codes des départements aux valeurs de l'indicateur
valuereg string ou number oui Valeur de l'indicateur Ă  l'Ă©chelle nationale
name string oui nom de l'indicateur
level String ('dep' ou 'reg') Non Niveau de zoom de la carte ('dep' pour départements, 'reg' pour régions)
selectedpalette string non palette de couleurs utilisée pour la carte
highlightIndex Number, String ou Array non Code ou liste des codes géographiques à mettre en avant

Résumé des paramètres de MapChart-reg

paramètre type obligatoire description
data string oui dictionnaire associant les codes des départements aux valeurs de l'indicateur
valuereg string ou number oui valeur de l'indicateur à l'échelle régionale
name string oui nom de l'indicateur
region string oui code de la région à afficher
selectedpalette string non palette de couleurs utilisée pour la carte

X. Documentation du composant DataBox

Le composant DataBox est un composant polyvalent qui permet d'afficher des données sous différentes formes, notamment des indicateurs, des graphiques, des tableaux, etc. Il intègre également des fonctionnalités interactives telles que des sélecteurs de sources, des modales, et des menus déroulants pour des actions supplémentaires.

Importation du composant

Pour utiliser le composant DataBox, vous devez l'importer dans votre fichier Vue :

javascript

Copier le code

import DataBox from './DataBox.vue';

Utilisation de base

Exemple :

<data-box
  :dataBoxTitle="Votre titre"
  :dataBoxDescription="Votre description"
  :value="1500"
  :indicator="true"
  :trendValue="'5%'"
  :component="'PieChart'"
  :serieObj="serieObj"
  :source="'Source de données'"
  :dataBoxDate="'2024-04-22'"
></data-box>

Props

Voici la liste des props disponibles pour le composant DataBox :

Principales :

  • dataBoxTitle (String) (par dĂ©faut : "Titre de la dataBox")
    Titre affiché en haut de la DataBox.

  • dataBoxDescription (String) (par dĂ©faut : "Description de la dataBox.")
    Description affichée dans l'infobulle associée au titre.

  • indicator (Boolean) (par dĂ©faut : false)
    Indique si la DataBox affiche un indicateur principal (valeur) avec une tendance.

  • trendValue (String) (par dĂ©faut : "5")
    Valeur de la tendance (hausse ou baisse) affichée à côté de l'indicateur principal.

  • value (String) (par dĂ©faut : "1500")
    Valeur de l'indicateur principal affichée dans la DataBox.

  • component (String) (par dĂ©faut : "PieChart")
    Nom du composant de graphique Ă  afficher dans la DataBox. Les options possibles sont : "PieChart", "BarChart", "MultiLineChart", "MapChart", etc.

  • serieObj (Object)
    Objet contenant les données à afficher dans le graphique ou le tableau. Voir la section Structure de serieObj.

Options supplémentaires :

  • addSources (Boolean) (par dĂ©faut : false)
    Affiche un sélecteur de sources si défini à true.

  • select_options (Array) (par dĂ©faut : [{ value: "ubm", label: "Exposition mĂ©diatique" }])
    Liste des options pour le sélecteur de sources.

  • option_default (String) (par dĂ©faut : "ubm")
    Valeur par défaut sélectionnée dans le sélecteur de sources.

  • captionTitle (String) (par dĂ©faut : "Titre du tableau")
    Titre du tableau si un tableau est affiché.

  • isMultilineTableHeader (Boolean) (par dĂ©faut : true)
    Indique si l'en-tĂŞte du tableau peut ĂŞtre sur plusieurs lignes.

  • dataBoxDate (String) (par dĂ©faut : "2024-04-22")
    Date des données affichées, formatée en YYYY-MM-DD.

  • source (String) (par dĂ©faut : "SIG")
    Source des données affichées dans la DataBox.

  • modalSettings (Object)
    Paramètres pour la modale associée à la DataBox.

    • hasModal (Boolean) (par dĂ©faut : false)
      Indique si une modale est associée à la DataBox.

    • modalId (String) (par dĂ©faut : "fr-modal-1")
      Identifiant unique de la modale.

  • dropdownActions (Array)
    Liste des actions disponibles dans le menu déroulant.

    • Chaque action est un objet avec les propriĂ©tĂ©s suivantes :
      • id (String) : Identifiant unique de l'action.
      • ariaLabel (String) : Label pour l'accessibilitĂ©.
      • action (String) : Nom de la mĂ©thode Ă  exĂ©cuter lors du clic.
  • unitTooltip (String) (par dĂ©faut : "")
    Unité à afficher dans l'infobulle du graphique.

Structure de serieObj

L'objet serieObj contient les données nécessaires pour alimenter le graphique ou le tableau. Voici sa structure par défaut :

javascript

serieObj: { showGraph: true, unitTooltip: "%", serie_values: { x: ["Serie 1", "Serie 2", "Serie 3"], y: [100, 200, 300], name: ["Nom Serie 1", "Nom Serie 2", "Nom Serie 3"], color: ["#FF0000", "#00FF00", "#0000FF"], // Autres propriétés spécifiques au type de graphique }, table: [ ["Serie 1", "100"], ["Serie 2", "200"], ["Serie 3", "300"], ], istable: false, // Indique si le tableau doit être affiché id_accordion: "uniqueId", // Identifiant pour les contrôles segmentés }

Notes sur serieObj :

  • showGraph : Indique si le graphique doit ĂŞtre affichĂ©.
  • unitTooltip : UnitĂ© Ă  afficher dans l'infobulle du graphique (peut ĂŞtre redondant avec la prop unitTooltip).
  • serie_values : Contient les donnĂ©es pour le graphique.
    • x : DonnĂ©es pour l'axe des abscisses.
    • y : DonnĂ©es pour l'axe des ordonnĂ©es.
    • name : Noms des sĂ©ries (optionnel).
    • color : Couleurs des sĂ©ries (optionnel).
    • vline, vlinecolor, vlinename, hline, hlinecolor, hlinename : PropriĂ©tĂ©s pour les lignes verticales et horizontales (si applicable).
  • table : DonnĂ©es Ă  afficher dans le tableau.
  • istable : Indique si le tableau doit ĂŞtre affichĂ© Ă  la place du graphique.
  • id_accordion : Identifiant utilisĂ© pour les contrĂ´les segmentĂ©s (graphique/tableau).

MĂ©thodes

Le composant DataBox expose plusieurs méthodes internes :

  • changeDateFormat(date) : Formate une date au format DD/MM/YYYY.
  • toggleView(viewType) : Change la vue entre le graphique et le tableau (viewType peut ĂŞtre "graphique" ou "tableau").
  • toggleDropdown() : Ouvre ou ferme le menu dĂ©roulant des actions.
  • handleClickOutside(event) : Gère le clic en dehors du menu dĂ©roulant pour le fermer.
  • transfertSourceOption(selectedOption) : Émet l'Ă©vĂ©nement select-source-api avec l'option sĂ©lectionnĂ©e en paramètre.
  • handleChartSelected(type) : Gère le changement de vue via les contrĂ´les segmentĂ©s.
  • performAction(action) : ExĂ©cute l'action sĂ©lectionnĂ©e dans le menu dĂ©roulant.
  • actionBtn1(), actionBtn2() : MĂ©thodes par dĂ©faut pour les actions du menu dĂ©roulant (Ă  personnaliser).

Événements émis

  • open-modal : Émis lors du clic sur le bouton pour ouvrir la modale.
  • select-source-api : Émis lors de la sĂ©lection d'une option dans le sĂ©lecteur de sources, avec l'option sĂ©lectionnĂ©e en paramètre.

Slots

Le composant DataBox ne définit pas de slots.

Computed Properties

  • chartProps : GĂ©nère les props Ă  passer au composant de graphique en fonction de serieObj.
  • shouldDisplayLegend : Indique si la lĂ©gende du graphique doit ĂŞtre affichĂ©e.
  • shouldDisplayChart : Indique si le graphique doit ĂŞtre affichĂ©.
  • shouldDisplayTable : Indique si le tableau doit ĂŞtre affichĂ©.

Styles

Le composant utilise des styles spécifiques définis dans dataBox.scss. Il importe également des composants et styles de l'application (par exemple, les styles des boutons, infobulles, etc.).

Exemples d'utilisation

DataBox avec indicateur et tendance

<data-box
  dataBoxTitle="Nombre de visiteurs"
  dataBoxDescription="Nombre total de visiteurs sur le site en 2023"
  value="1500"
  indicator="true"
  trendValue="-5%"
  source="Google Analytics"
  dataBoxDate="2023-10-01"
></data-box>

DataBox avec graphique en secteurs (PieChart)

<data-box
  dataBoxTitle="RĂ©partition des ventes par produit"
  component="PieChart"
  :serieObj="{
    showGraph: true,
    serie_values: {
      x: ['Produit A', 'Produit B', 'Produit C'],
      y: [30, 50, 20],
    },
    table: [
      ['Produit A', '30'],
      ['Produit B', '50'],
      ['Produit C', '20'],
    ],
  }"
  source="Base de données interne"
  dataBoxDate="2023-09-15"
></data-box>

DataBox avec tableau uniquement

<data-box
  dataBoxTitle="Liste des utilisateurs inscrits"
  :serieObj="{
    showGraph: false,
    istable: true,
    table: [
      ['Nom', 'Email'],
      ['Alice', 'alice@example.com'],
      ['Bob', 'bob@example.com'],
      ['Charlie', 'charlie@example.com'],
    ],
  }"
  source="Système d'inscription"
  dataBoxDate="2023-08-20"
></data-box>

Interactivité et personnalisation

Le composant DataBox est conçu pour être hautement personnalisable et interactif. Vous pouvez :

  • Afficher ou masquer des sections en fonction des props (indicator, addSources, etc.).
  • Ajouter des actions personnalisĂ©es dans le menu dĂ©roulant en dĂ©finissant la prop dropdownActions et en implĂ©mentant les mĂ©thodes correspondantes.
  • GĂ©rer l'affichage entre le graphique et le tableau grâce aux contrĂ´les segmentĂ©s.

Remarques

  • Le composant utilise des composants enfants tels que PieChart, BarChart, MultiLineChart, SelectSource, SegmentedControls, TableVue, et MapChart. Assurez-vous que ces composants sont correctement importĂ©s et enregistrĂ©s dans votre application.
  • Pour les icĂ´nes et les styles, le composant semble utiliser le Design System de l'État Français (DSFR). Assurez-vous d'avoir les dĂ©pendances nĂ©cessaires si vous souhaitez conserver le mĂŞme style.

Accessibilité

Le composant inclut des considérations pour l'accessibilité, comme l'utilisation d'aria-label, aria-describedby, et des rôles appropriés pour les infobulles et les modales.


XI. Accessibilité

Tableaux

Les résultats peuvent également être présenté sous la forme d'un tableau. Ceci permet dans certaines situations d'offrir une alternative à la visualisation des données et ainsi s'adapter au public concerné.

Les paramètres obligatoires sont :

  • x : les noms de chaque groupe sous la forme d’une liste entre crochets

  • y : les valeurs de chaque groupe sous la forme d’une liste entre crochets


XII. Options

Barre verticale

Il est possible d’ajouter une ou plusieurs barres verticales par l’intermédiaire du paramètre :

  • vline : La ou les valeur(s) sur l’axe des abscisses sous la forme d’une liste entre crochets

Par défaut la couleur de la ligne sera #161616 et son nom V1, V2, … Cela peut être modifié en renseignant les paramètres :

  • vlinecolor : La ou les couleur(s) sous forme d’une liste entre crochets

  • vlinename : Le ou les nom(s) sous la forme d’une liste entre crochets

Exemple :

<line-chart
  x="[1, 2, 3]"
  y="[10, 20, 30]"
  vline="[1.5, 2.5]"
  vlinename='["min", "max"]'
  vlinecolor='["green-archipel", "blue-ecume"]'
></line-chart>

Barre horizontale

Il est possible d’ajouter une ou plusieurs barre(s) verticale(s) par l’intermédiaire du paramètre :

  • hline : La ou les valeur(s) sur l’axe des ordonnĂ©es sous la forme d’une liste entre crochets

Par défaut la couleur de la ligne sera #009081 et son nom H1, H2, … Cela peut être modifié en renseignant les paramètres :

  • hlinecolor : La ou les couleur(s) sous forme d’une liste entre crochets

  • hlinename : Le ou les nom(s) sous la forme d’une liste entre crochets

Exemple :

<line-chart
  x="[1, 2, 3]"
  y="[10, 20, 30]"
  hline="[15, 25]"
  hlinename='["min", "max"]'
  hlinecolor='["green-archipel", "blue-ecume"]'
></line-chart>

Contribution

Le processus de contribution est détaillé sur la page CONTRIBUTING.md.