D3.js

De BdC de chez Wam...


Cette page est en grande partie issue de : Visualisation de données - d3.js

d3.js est une librairie javascript très complète avec beaucoup d’exemples à disposition, avec une personnalisation totale possible. Elle permet l’accès à des primitives SVG permettant toute innovation. Malheureusement, elle est peu accessible directement et assez technique.

Fonctionnement typique

L’idée principale est de lier les données au DOM (Document Object Model), et d’appliquer des transformations, basées sur les données, au document.

Il y a plusieurs concepts spécifiques à bien comprendre pour l’utiliser pleinement :

  • Sélection, modification, ajout et insertion d’éléments
  • Ajout de données au DOM
  • Propriété dynamique, et Transformation
  • Chaînage des fonctions

Base

Sélection

Il existe deux fonctions de sélection respectivement d’un seul élément (avec select()) et de l’ensemble des éléments (avec selectAll()) correspondant à la définition passée en paramètre :

var selection1 = d3.select("selecteur");
var selection2 = d3.selectAll("selecteur");

Quand on utilise une sélection d’un seul élément (avec select() donc), mais qu’il existe plusieurs éléments de ce type dans le document, c’est le premier qui est renvoyé.

La sélection se fait de manière identique que pour le CSS :

  • "balise" : pour tout ce qui est balise html (div, h1, body, …)
  • ".maclasse" : pour le ou les objets de la classe indiquée (indiquée via "class='maclasse'")
  • "#identifiant" : pour l’objet (unique normalement) avec cet identifiant (indiquée via "id='identifiant'")

Ces sélecteurs permettent ensuite d’accéder à plusieurs fonctions utiles pour manipuler les objets, comme nous le verrons. Voici trois premières fonctions :

  • size() : taille de la sélection
  • empty() : sélection vide ou non
  • html() : contenu html de la sélection

Modification, ajout et insertion d’éléments

Plusieurs fonctions permettent de modifier les éléments sélectionnés (comme par exemple style() pour appliquer des règles CSS ou html() pour modifier le contenu de la balise). Le code suivant permet de mettre le texte en rouge pour tout le corps de la page

var corps = d3.select("body");
corps.style("color", "red");

Deux fonctions sont utiles pour respectivement insérer un élément HTML fils à la fin (append()) ou au début (insert()) d’un élément père, qui s’utilisent comme suit :

selection.append("balise");
selection.insert("balise");

Exemple

Ici, on sélectionne la balise <body> (qui est vide au départ). Dans cette sélection, on ajoute deux balises div, pour mettre dans la première la taille de la sélection (1 normalement) et dans la seconde le test si elle est vide ou non (normalement false). Enfin, on met le texte de la sélection en rouge (donc tout).

// Sélection de la balise body
var corps = d3.select("body");

// Ajout de deux balises div au corps
var div1 = corps.append("div");
var div2 = corps.append("div");

// Définition du contenu des deux balises
div1.html("Je met du texte ici.");
div2.html("Nombre de div : " + d3.selectAll("div").size());

// Modification de la couleur de la police
corps.style("color", "red");
div2.style("color", "steelblue");

Ajout de données au DOM

Avec la fonction data() sur une sélection, il est possible de lier les données passées en paramètres (ce doit être un tableau) au DOM à la sélection en question. Le code suivant affecte chaque élément du tableau à chaque élément renvoyé par le sélecteur précédent

var selection = d3.selectAll("selecteur");
selection.data(tableau);

S’il y a différence entre la taille de la sélection et la taille du tableau passé en paramètre de data(), il existe deux fonctions utiles pour gérer ces cas :

  • enter() : pour gérer les éléments du tableau en plus
  • exit() : pour gérer les éléments de la sélection en plus

Propriété dynamique

Sur chaque sélection, on peut appliquer des modifications de style ou de contenu (voire autre), en fonction des données sont liées au DOM. On passe par l’utilisation d’une fonction anonyme, dont les paramètres peuvent être, dans cet ordre :

  • la valeur de l’élément du tableau affectée à l’élément
  • la position de la valeur dans le tableau
  • il est possible de n’utiliser que la valeur, voire aucun paramètre si besoin

var selection = d3.selectAll("selecteur");
selection.data(tableau);
selection.html(function(d, i) {
    return "position = " + i + ", valeur = " + d;
})

Exemples

Ajout de données + propriété dynamique

Dans cet exemple, on affecte les données du tableau (qui contient des couleurs) à chaque div du body. Et on affecte un style CSS (la couleur), en prenant comme valeur celle contenu dans le tableau.

HTML
Pomme
Tomate
Fleur
JS

var div = d3.selectAll("div");
div.data(["green", "red", "blue"])
div.style("color", function (d) { return d; });

fonction enter()

Le tableau passé en paramètre de data() est ici plus long que la sélection. Pour les valeurs supplémentaires du tableau (sélectionnées avec le enter()), on ajoute des div (avec append()).

HTML
Pomme
Tomate
Fleur
JS

// div : liste des div présents dans le HTML
var div = d3.select("body").selectAll("div");
/* Le select("body") n'est la que pour s'assurer que les div soient bien
   ajoutée dans le body et non après */
// div_data : div avec les données associées
var div_data = div.data(["green", "red", "blue", "orange", "purple"]);
// affectation de la couleur à chaque div
div.style("color", function (d) { return d; });
// div_enter : données en trop
var div_enter = div_data.enter();
// div_nv : nouvelles div ajoutée à partir des données en trop
var div_nv = div_enter.append("div");
// définition du contenu des nouvelles div
div_nv.html("div ajoutée");
// affectation de la couleur à chaque nouvelle div
div_nv.style("color", function (d) { return d; });

fonction exit()

C’est ici le contraire, le tableau est plus petit que la sélection. Pour les éléments de la sélection en trop (sélectionnés avec le exit()), on les supprime (avec remove()).

HTML
Pomme
Tomate
Fleur
JS

// div : liste des div présents dans le HTML
var div = d3.select("body").selectAll("div");
// div_data : div avec les données associées
var div_data = div.data(["green", "red"]);
// affectation de la couleur à chaque div
div.style("color", function (d) { return d; });
// div_exit : div en trop
var div_exit = div_data.exit();
// suppression de ces div en trop
div_exit.remove();
// on peut remplacer par cette ci-dessous, qui change le contenu de la div en trop
// div_exit.html("en trop");

Chaînage des fonctions

Il faut absolument comprendre le principe généralement appliqué en JS orienté objet :

Toute fonction d’un objet renvoie cet objet

Ceci est vrai sauf si la fonction a pour but de renvoyer un résultat spécifique. Et cela ne concerne donc que les procédures (qui sont aussi des fonctions en JS).

Le corollaire de ce principe est intéressant :

Il est possible d’enchaîner un grand nombre de fonctions directement

Dans l’exemple ci-dessous, on utilise ce principe pour créer autant de div qu’il y a de couleurs dans le tableau, en indiquant le contenu HTML de celles-ci, et en leur appliquant un style CSS spécifique.

var couleur = ["green", "red", "blue", "orange", "purple"];
d3.select("body").selectAll("div")
  .data(couleur)
  .enter().append("div")
    .html(function(d,i) { return "Div n°" + (i + 1) + " : " + d; })
    .style("color", function(d, i) { return d; });

Lecture de données

Il existe plusieurs fonctions dans la librairie D3 pour charger des données de tout type (JSON, CSV, TSV, XML, …). Les fonctions pour le faire sont toutes de type d3.xxx() (xxx étant remplacé par le format approprié - d3.json() pour du JSON par exemple).

L’exemple ci-dessous charge les données contenues dans le fichier mpg.csv (qui recense un ensemble de voitures, avec plusieurs caractéristiques).

d3.csv("https://fxjollois.github.io/donnees/mpg.csv",
       function(err, don) {
  console.log(don);
  if (err)
    d3.select("body").html("Erreur : " + err)
  else {
    d3.select("body").selectAll("div")
      .data(don)
      .enter()
      .append("div")
      .html(function(e, i) {
        var r = "" + e.manufacturer + ", " +
            e.model +
            " (" + e.year + ")";
        return r;
     });
   }
})

Ajout d’interactivité

Il est possible d’ajouter des gestions d’événements sur les objets créés via la fonction on(). Celle-ci prend en premier paramètre l’événement (par exemple mouseover pour gérer le positionnement de la souris sur l’objet), et en deuxième paramètre la fonction à appliquer lors de la survenue de cet évènement.

Dans cette fonction, il n’y aucun paramètre possible. Mais nous avons accès à l’objet via this. Si de plus, nous avons pris le soin d’ajouter des propriétés à cet objet (via la fonction property("nom", valeur)), nous pouvons y accéder à la valeur via this.nom.

Dans l’exemple ci-dessous, nous ajoutons à chaque div la gestion du passage de la souris sur celle-ci (ainsi que sa sortie). Pour cela, nous ajoutons une propriété couleur à chacune, qui prendra la valeur de la couleur dans le tableau. Ensuite, on indique que lorsque la souris passe sur la div (on("mouseover", ...)), on change la couleur de la police par celle spécifique à la div.

Si nous ne gérons pas la sortie de la souris, la couleur ne sera jamais rechangé. Nous gérons donc ce cas (via on("mouseout, ...)) en indiquant que la couleur redevient noire.

HTML

Première div
Deuxième div
Troisième div

JS

d3.selectAll("div")
  .data(["green", "red", "blue"])
  .property("couleur", function(d) { return d;})
  .on("mouseover", function () {
    d3.select(this).style("color", this.couleur);
  })
  .on("mouseout", function () {
    d3.select(this).style("color", "black");
  });

Pour récupérer les informations de la souris, il existe l’objet d3.event qui contient en particulier les informations suivantes :

  • clientX et clientY : position relative à la partie visible du navigateur
  • screenX et screenY : position relative au moniteur
  • offsetX et offsetY : position relative à l’objet sur lequel la souris est (implémentation variable entres les navigateurs)
  • pageX et pageY : position relative au document HTML

Voici un petit exemple de ce qu’on peut récupérer comme informations.

HTML

<svg width=200 height=100></svg>
<div id = "infos">
   <div id = "client"></div>
   <div id = "screen"></div>
   <div id = "page"></div>
  <div id = "offset"></div>
</div>

CSS

svg {
  border: solid 1px black;
  margin-left: 50px;
  margin-top: 50px;
}
#infos {
  width: 200px;
  float: right;
}
#client::before {
  content: "client : "
}
#screen::before {
  content: "screen : "
}
#page::before {
  content: "page : "
}
#offset::before {
  content: "offset : "
}

JS

d3.select("svg")
  .on("mousemove", function () {
    m = d3.event;
    d3.select("#client").html(m.clientX + "-" + m.clientY);
    d3.select("#screen").html(m.screenX + "-" + m.screenY);
    d3.select("#page").html(m.pageX + "-" + m.pageY);
    d3.select("#offset").html(m.offsetX + "-" + m.offsetY);
  })
  .on("mouseout", function () {
    d3.select("#infos").selectAll("div").html("");
  });