FreeDatas2HTML

Documentation FreeDatas2HTML

Sommaire

Installer FreeDatas2HTML

Pour l’instant FreeDatas2HTML n’est pas disponible sur NPM.
Vous devez donc en récupérer une copie sur le dépôt GIT du projet.
Si vous travaillez en TypeScript, vous pouvez directement utiliser les fichiers présents dans le répertoire /src et ignorer le sous-répertoire /build.
Si vous travaillez en JavaScript, vous devez au contraire utiliser les scripts présents dans le répertoire /src/build.

Instancier la classe principale

Une fois les scripts présents dans le répertoire de votre projet, vous pouvez les importer comme n’importe quel module :
import { FreeDatas2HTML } from "./modules/FreeDatas2HTML";
À supposer que les scripts soient situés dans le sous-répertoire FreeDatas2HTML du répertoire modules de votre projet.

Suivant ce que vous souhaitez faire, vous aurez peut-être besoin d’importer d’autres classes, comme indiqué plus loin.

Ensuite, dans votre script, vous pouvez créer votre instance de manière classique :
const myConverter=new FreeDatas2HTML("CSV");

Type de données

Le premier argument du constructeur est obligatoire et vous permet d’indiquer le format des données à parser, avec trois options possibles : « CSV », « JSON », « HTML ».

Fournir directement les données à parser

Si vous avez déjà les données à parser sous la main, vous pouvez les fournir en deuxième argument du constructeur sous forme d’une chaîne de caractère :
const myConverter=new FreeDatas2HTML("JSON", `[{ "name": "Doe", "firstname" : "John" },{ "name": "Doe", "firstname" : "Janie" }]`);

Mais vous pouvez très bien fournir ou modifier cette information après l’instanciation :
myConverter.parser.datas2Parse=`[{ "name": "Doe", "firstname" : "John" },{ "name": "Doe", "firstname" : "Janie" }]`;

Importer les données à partir d’une source distante

Le dernier argument, vous permet de passer une instance de la classe RemoteSource qu’il vous faudra au préalable avoir importée et déclarée :
import { FreeDatas2HTML, RemoteSource } from "./modules/FreeDatas2HTML";
const mySource=new RemoteSource({ url:"https://www.example.com/datas.csv" });
const myConverter=new FreeDatas2HTML("CSV","", mySource);

En fait, il sera accepté une instance de n’importe quelle classe validant l’interface RemoteSources que vous pouvez trouver déclarée dans le script interface.ts.

Vous pouvez fournir des entêtes pour l’appel à la source de données distantes :
mySource.headers=[ { key:"token", value:"1234" }, { key:"userName", value:"Toto" }];

Il vous est aussi possible de déclarer la propriété XMLHttpRequest.withCredentials :
mySource.withCredentials=true;

Mais vous pouvez aussi fournir la source de données distante après l’instanciation en utilisant le setter :
myConverter.parser.setRemoteSource({ url:"https://www.example.com/datas.csv" });

Dans ce cas l’importation préalable de la classe RemoteSource est inutile.
De nouveau, vous pouvez fournir des options :
myConverter.parser.setRemoteSource({ url:"https://www.example.com/datas.csv", headers:[{ key:"token", value:"1234" }], withCredentials:true });

Définir l’élément du DOM où seront affichées les données

Ceci est facultatif, car vous pouvez très bien simplement vouloir parser les données.
Mais si vous souhaitez que FreeDatas2HTML s’occupe d’afficher les données, vous pouvez indiquer l’id de l’élément de la page où les afficher :
myConverter.datasViewElt={ id:"myDatas" };
L’élément doit exister dans la page, sans quoi ce setter générera une erreur.

Parser les données

Pour lancer le parsage, utilisez la méthode run() qui est asynchrone :
await myConverter.run();

En cas de succès du parsage, si l’id de l’élément du DOM devant recevoir les données est connu, elles seront automatiquement affichées dans la page.

Dans tous les cas, une fois le parsage finalisé avec succès, vous pouvez accéder aux noms de champs et aux données trouvées :
const fields=myConverter.fields; // format de sortie: string[], exemple: ["fistname", "name"]
const datas=myConverter.datas; // format de sortie : {[index: string]:string}[], exemple: [{"firstname":"Janie", "name":"Doe"}, {"firstname":"John", "name":"Doe"}];
Les formats de sortie sont les mêmes, quel que soit le format des données parsées.

Tolérance aux erreurs de parsage

Le parseur peut rencontrer certaines erreurs ne le bloquant pas, mais correspondant à des anomalies, par exemple, une colonne en trop dans des données CSV.
Si vous souhaitez bloquer la suite quand cela arrive, il vous faut l’indiquer avant de lancer le parsage :
myConverter.stopIfParseErrors=true;
Par défaut, les erreurs de parsage sont tolérées.

Adapter le rendu visuel des données

Par défaut toutes les données trouvées seront affichées sous forme de tableau, sans classe CSS particulière :

<table>
 <thead><tr><td>firstname</td><td>name</td></tr></thead>
 <tbody>
  <tr><td>Janie</td><td>Doe</td></tr>
  <tr><td>John</td><td>Doe</td></tr>
 </tbody>
</table>

Ne pas afficher tous les champs disponibles

Si vous ne souhaitez pas afficher tous les champs trouvés dans les données, vous pouvez indiquer ceux à garder :
myConverter.fields2Rend=[0,2]; // n’affichera que le 1ᵉʳ et le 3ᵉ champ, la numérotation commençant à zéro.

Ce setter ne peut être utilisé qu’après le parsage, car il provoquera une erreur si vous fournissez un numéro de champ n’existant pas dans les données parsées.

Pour de nouveau afficher tous les champs (situation par défaut), il vous suffit de passer un tableau vide :
myConverter.fields2Rend=[];

Adapter le code HTML généré pour afficher des données

Pour spécifier le code HTML à générer, vous devez créer une instance de la classe Render ou d’une autre classe validant l’interface DatasRenders déclarée dans le script interface.ts.

Il faut commencer par l’importer et l’instancier :
import { FreeDatas2HTML, Render } from "./modules/FreeDatas2HTML";
…
const myRender=new Render();

Et ensuite utiliser l’attribut settings pour décrire ce que vous souhaitez obtenir :
myRender.settings=
{
    allBegining:"<h4>Moi je préfère les listes aux tableaux !</h4>",
    allEnding:"Pas vous ?",
    linesBegining:"<ul>",
    linesEnding:"</ul>",
    lineBegining:"<li><ul>",
    lineEnding:"</ul></li>",
    dataDisplaying:"<li><b>#FIELDNAME :</b> #VALUE</li>",
};

Dans ce cas, la configuration par défaut est écrasée par ce qui est fourni à settings.
Consulter le type DatasRendersSettings pour voir tous les attributs disponibles.

Si vous souhaitez simplement modifier un des attributs, vous pouvez le faire ainsi :
myRender.settings.allBegining="<table class='myTable'>";
Ici le tableau sera le même que précédément, seule la balise <table> s’est vu ajouter une classe CSS.

Dans les deux cas, il faut ensuite fournir votre Render à votre instance de FreeDatas2HTML :
myConverter.datasRender=myRender;

Besoin d’un rendu complexe, fusionnant plusieurs champs ?

Il est possible d’obtenir un rendu plus complexe, mixant les données venant de plusieurs champs.
C’est par exemple le cas si vous souhaitez créer un lien dont l’URL se trouve dans un champ et l’ancre dans un autre.

Ceci est possible via l’extension MixedFieldsRender.ts. Cette documentation ne présente pas l’usage de cette extension pour l’instant, mais vous pouvez vous inspirer du code utilisé par la page de démonstration de cette classe.

Afficher un compteur

Si vous souhaitez afficher quelque part le nombre d’enregistrements, il vous suffit de fournir l’id de l’élément de votre page devant recevoir cette information :
myConverter.datasCounterElt={ id:"ndDatas" };

Ce compteur sera ensuite mis à jour à chaque actualisation des données, en prennant en compte les filtres activés par l’utilisateur, mais en ignorant la pagination qui n’est qu’une commodité de navigation.

Si vous souhaitez vous-mêmes actualiser l’affichage de ce compteur, utilisez cette méthode :
myConverter.datasCounter2HTML();

Paginer les données

Par défaut, tous les enregistrements extraits de la source de données sont affichés à l’emplacement prévu dans la page.
Toutefois, vous pouvez les paginer et même proposer aux utilisateurs finaux de choisir le nombre de résultats à afficher par page.

Ceci est possible via la classe Pagination qui doit donc être importée et instanciée :
import { FreeDatas2HTML, Pagination } from "./modules/FreeDatas2HTML";
…
const myPagination=new Pagination(converter, { id:"pages" });

Ceci ne devant être fait qu’après avoir importé vos données, qui sont nécessaires à la pagination.

Le 1ᵉʳ paramètre est votre instance de FreeDatas2HTML et le deuxième l’id de l’élément HTML où sera injecté le SELECT permettant de passer d’une page à l’autre.
Un troisième paramètre peut vous permettre de personnaliser le texte dans le LABEL de ce SELECT :
const myPagination=new Pagination(converter, { id:"pages" }, "Aller à la page :");
Par défaut, il y sera affiché « Pages ».

Une fois votre classe instanciée, vous pouvez proposer un choix de pagination aux utilisateurs finaux :
myPagination.options={ displayElement: { id:"paginationOptions" }, values: [10,20,50,100] , name: "Choix de pagination :" };
Ici :

Vous pouvez aussi définir une valeur de pagination par défaut :
myPagination.selectedValue=10;
Si des options de pagination sont renseignées, cette valeur doit faire partie de celles proposées ou bien undefined pour afficher toutes les données.

Puis il vous reste à fournir votre pagination à votre instance FreeDatas2HTML :
myConverter.pagination=myPagination;

Si vous proposez des options de pagination, vous devez lancer l’injection du code HTML correspondant dans votre page :
myPagination.options2HTML();

Il y a une méthode similaire, pages2HTML(), pour injecter le code du SELECT permettant de changer de page.
Mais vous n’avez pas à vous en occuper, car c’est FreeDatas2HTML qui appelle cette méthode à chaque fois que l’affichage des données est actualisé.
Car suivant les filtres activés par l’utilisateur, le nombre d’enregistrements peut changer et par conséquent le nombre de pages à proposer.
Quand il y a moins de données affichées que le nombre maximum prévu par page, ce SELECT n’est pas affiché.

Proposer des filtres pour les données

Les filtres sont des éléments SELECT listant, de manière classée et dédoublonnée, toutes les valeurs distinctes disponibles pour un champ.
Le classement se fait par ordre « naturel », c’est-à-dire par ordre alphabétique ignorant la casse pour les chaînes. De même pour les nombres, « 02 » ne sera pas avant « 1 », bien que « 0 » précède « 1 »…
Pour des besoins particuliers, il vous est possible d’utiliser votre propre fonction de classement, ce qui sera expliqué plus loin.

Si plusieurs filtres sont proposés à l’utilisateur final, seuls les enregistrements validant tous les choix de l’utilisateur seront affichés.

Pour ajouter un filtre, commencer par l’inclure dans votre script et créer une instance :
import { FreeDatas2HTML, Selector } from "./modules/FreeDatas2HTML";
…
const myFilter1=new Selector(myConverter, 3, { id:"filter1"});

Les trois premiers paramètres sont obligatoires :

Un quatrième paramètre facultatif permet d’indiquer un séparateur, qui vous sera utile si un champ contient plusieurs valeurs pour un même enregistrement.
Par exemple, à supposer que vous souhaitiez créer un filtre sur le 3ᵉ champ (donc le numéro 2 !) contenant des mots-clés séparés par des point-virgule, voici le code à utiliser :
const myFilter2=new Selector(myConverter, 2, { id:"filter2"}, ";" );

Attention, vous devez d’abord avoir parsé vos données avant de créer votre instance de Selector, car l’existence du champ fourni en paramètre est testé à cette étape.

Une fois votre instance créée, en attribut supplémentaire permettra à l’utilisateur de sélectionner plusieurs valeurs dans la liste :
myFilter2.isMultiple=true;
Ce n’est pas le cas par défaut. Si le choix multiple est permis, tout enregistrement valide pour au moins une des valeurs sélectionnées dans la liste sera affiché.

L’instanciation va aussi récupérer les données distinctes à proposer dans la liste.
Vous pouvez récupérer cette liste de valeurs, via le code suivant :
const filter1Datas=myFilter1.values;
Il s’agit d’un tableau de chaînes de caractères. Par exemple pour des années : ["1998", "2000", "2005" …]

Une fois la configuration terminée, vous pouvez injecter votre liste dans la page via le code suivant :
myFilter.filter2HTML();

Par défaut, le LABEL affiché devant la liste sera le nom du champ concerné, tel que présent dans les données traitées.
Si vous souhaitez afficher un autre texte, vous pouvez le passer en paramètre :
myFilter.filter2HTML("Choisissez une valeur :");

Pour que votre filtre soit effectivement actif, il vous faut ensuite le transmettre à votre instance de FreeDatas2HTML.
Vous pouvez passer tous vos filtres en une seule fois :
myConverter.datasFilters=[myFilter1, myFilter2, myFilter3];
Il sera en fait acceptée toute instance d’une classe respectant l’interface Filters décrite dans le script interface.ts.

Un moteur de recherche est en fait un filtre comme les autres ou presque !
Effectivement, dans les deux cas il est proposé à l’utilisateur final de filtrer les données suivant son choix, qu’il pourra effectuer librement dans un moteur de recherche ou de manière contrainte dans une liste de sélections.

Les deux classes Filter et SearchEngine implémentent d’ailleurs la même interface : Filters.
Et comme dit plus haut, toute instance d’une classe validant cette interface sera acceptée comme filtre par FreeDatas2HTML.

Bref pour ajouter un moteur de recherche, il faut de nouveau importer la classe et l’instancier :
import { FreeDatas2HTML, SearchEngine } from "./modules/FreeDatas2HTML";
…
const mySearch=new SearchEngine(myConverter, { id:"search" });

Les deux premiers paramètres sont obligatoires :

Définir les champs à utiliser pour votre recherche

Un troisième paramètre vous permet de préciser la liste des champs dans lesquels la saisie de l’utilisateur sera recherchée. Par exemple, pour limiter la recherche aux troisième et quatrième champs :
const mySearch=new SearchEngine(myConverter, { id:"search" }, [2,3]);

Vous pouvez ainsi avoir dans vos données un champ contenant des mots-clés utiles à votre moteur de recherche, sans pour autant les afficher dans la page… Par défaut la recherche se fait donc dans tous les champs présents dans les données, même s’ils ne sont pas affichés.

Personnaliser l’apparence du moteur de recherche

Vous pouvez ensuite personnaliser l’apparence de votre moteur de recherche via certains attributs.

Le texte du label du champ de saisie :
mySearch.label="Votre recherche :"; // par défaut vide, il n’y aura alors pas de <label>

Le texte du bouton lançant la recherche :
mySearch.btnTxt="Va chercher !"; // par défaut : Search

Ou encore le placeholder s’affichant dans le champ de saisie :
mySearch.placeholder="Saisir votre recherche"; // par défaut vide ou « Please enter at least NB characters. », s’il est renseigné un nombre minimum de caractères pour lancer la recherche automatique.

Lancement automatique de la recherche ?

Pour que la recherche soit lancée dès la saisie :
mySearch.automaticSearch=true; // par défaut false
En fixant éventuellement au nombre minimum de caractères :
mySearch.nbCharsForSearch=2; // si l’option précédente est à « true », par défaut la recherche sera lancée dès le premier caractère saisi. Les espaces entourant la saisie sont ignorés.

Ce nombre de caractères minimum ne concerne pas le bouton lançant la recherche.
En mode recherche automatique lorsque le champ de saisie est vidé par l’utilisateur, l’affichage est actualisé pour ne plus prendre en compte ce filtre.

Recherche stricte ou « lâche » ?

Sachez que par défaut la recherche de la valeur se fait de manière « lâche », c’est-à-dire en ignorant la casse, les accents ou encore les caractères spéciaux.
Par ailleurs, si plusieurs expressions séparées par des espaces sont saisies, elles sont cherchées séparément dans les enregistrements, mais doivent toutes être trouvées pour qu’un enregistrement soit affiché en résultat.

En effet, les utilisateurs prennent rarement la peine de saisir l’orthographe exacte de ce qu’ils cherchent.
Mais cela peut créer des faux positifs et si vous souhaitez une recherche plus stricte, l’attribut « searchMode » vous permet de préciser votre besoin :

(*) Seuls les caractères de l’alphabet latin (a, b…z) et les 10 chiffres de la base décimale (0, 1…9) sont considérés comme des caractères non spéciaux. Donc, par défaut, tout autre caractère saisi sera ignoré.

Évidemment toutes les options précédentes peuvent être passées en une seule fois :
mySearch.searchMode={ accentOff=false, caseOff=false, separatedWords=false, specialCharsOff=false }; // les recherches lancées seront strictes

Intégration à la page et activation

Une fois configuré, vous pouvez afficher votre moteur de recherche de la même manière que pour les filtres précédents :
mySearch.filter2HTML();

Sans oublier de le transmettre à votre instance FreeDatas2HTML, sans quoi il sera inactif :
myConverter.datasFilters=[mySearch];

Ce qui peut être fait conjointement à vos autres filtres :
myConverter.datasFilters=[myFilter1, myFilter2, mySearch];

Permettre de classer les données affichées

Un dernier outil va donner la possibilité à vos utilisateurs de classer les données affichées via le champ de leur choix.
Pour ce faire, il est nécessaire que le rendu que vous avez choisi propose des entêtes de colonnes, ce qui est typiquement le cas des tableaux HTML contenant des balises <TH>.
L’utilisateur pourra ainsi cliquer sur l’entête d’une colonne pour classer les données dans un sens, puis de nouveau cliquer pour les classer dans l’autre sens, etc.

Pour utiliser cet outil, comme d’habitude, il vous faut commencer par importer sa classe et l’instancier pour chaque champ/colonne ouverte au classement :
import { FreeDatas2HTML, SortingField } from "./modules/FreeDatas2HTML";
…
const mySortingField1=new SortingField(myConverter, 0);
const mySortingField2=new SortingField(myConverter, 3);

Le premier paramètre est votre instance de FreeDatas2HTML et le deuxième le numéro du champ concerné, qui doit évidemment être affiché dans la page…
Un troisième paramètre facultatif, vous permet de désigner le sélecteur CSS à utiliser pour trouver les entêtes dans votre code HTML (par défaut, « TH ») :
const mySortingField1=new SortingField(myConverter, 0, "td.fieldNames");
Ce sélecteur CSS doit retourner le même nombre d’éléments qu’il y a de champs affichés dans votre page, sans quoi il y aura une erreur.

Une fois tous vos champs de classement instanciés, il vous faut les transmettre à votre instance FreeDatas2HTML :
myConverter.datasSortingFields=[mySortingField1, mySortingField2];

Il est préférable de les transmettre avant le 1ᵉʳ affichage, car c’est FreeDatas2HTML qui s’occupera de rendre ses éléments cliquables.
Dans le cas contraire, vous pouvez toujours actualiser l’affichage après coup :
myConverter.refreshView();

Une fois les liens de classement installés, vous n’avez plus à vous en occuper.
Toutefois si vous souhaitez intervenir, l’attribut order est disponible :
mySortingField1.order="desc"; // accepte "asc", "desc" ou undefined.

À noter qu’une extension est proposée pour vous permettre de créer des liens de classement, même quand vous n’avez pas prévu d’entêtes dans le rendu de vos données.
Il s’agit de la classe SortingFieldsStandAlone qui n’est pas documentée ici pour l’instant. Mais vous pouvez étudier le code d’une des pages de démonstration l’utilisant.

Personnaliser la façon de classer les données

Comme déjà indiqué, par défaut les classements se font de manière « naturelle », c’est-à-dire par ordre alphabétique ignorant la casse pour les chaînes de caractère. Pour les nombres, l’éventuel « 0 » initial sera ignoré, etc.

Toutefois, la façon de classer certaines données doit être explicitée. C’est par exemple le cas de la 4ᵉ colonne de la page de démonstration listant des éléments chimiques. Vous y trouver des textes « Inexistant », « Traces » ou encore des opérateurs de comparaison comme « > 1 et < 100 000 ». Comment faire pour trier ces données ?

Dans ce cas, il vous faut fournir une fonction personnalisée de classement à votre instance de FreeDatas2HTML. Cette fonction doit être compatible avec la fonction sort() de JavaScript.
Voici par exemple, la fonction utilisée dans la page de démonstration :
const mySort=(a: any, b: any, order: "asc"|"desc" = "asc") =>
{
    const values=[ "> 100000", "> 1 et < 100 000", "≤ 1",  "Traces", "Inexistant"];
    if(order === "desc")
        values.reverse();
    if(values.indexOf(a) > values.indexOf(b))
        return -1;
    else if(values.indexOf(a) < values.indexOf(b))
        return 1;
    else
        return 0;
};

Une fois toutes vos fonctions de classement définies, il vaut faut les associer aux champs concernés :
myConverter.datasSortingFunctions=[{ datasFieldNb:4, sort:mySort }, { datasFieldNb:5, sort:mySort2 }];

Il est important de les associer à votre instance avant de déclarer toute autre fonctionnalité en ayant besoin : filtres SELECT, colonnes de classement…

Conclusion

Cette documentation n’est sans doute pas exhaustive, mais vous donne les principales clés pour intégrer FreeDatas2HTML à votre projet.

Pour une adaptation plus poussée à vos besoins, je vous encourage à étudier directement le code source et notamment les interfaces qui vous permettent de créer vos propres classes pour gérer l’affichage, les filtres, la pagination, etc. tout en continuant à bénéficier du reste du code de FreeDatas2HTML.