FreeDatas2HTML/public/documentation.html

440 lines
34 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="fr-fr">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<meta name="description" content="Documentation du module TypeScript/JavaScript FreeDatas2HTML.">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="robots" content="index,follow">
<link rel="stylesheet" href="CSS/paper.min.css">
<link rel="stylesheet" href="CSS/fd2html.css">
<script src="JS/matomo.js" defer></script>
<title>Documentation de FreeDatas2HTML</title>
</head>
<body class="paper container">
<header id="header" class="text-center">
<h1><a href="/">FreeDatas2HTML</a></h1>
<nav id="menu-principal">
<ul class="inline row flex-center">
<li><a href="./#intro" class="badge warning sm-12 col">Introduction</a></li>
<li><a href="./examples.html#content" class="badge success sm-12 col">Exemples</a></li>
<li><a href="./documentation.html#content" class="badge success sm-12 col">Documentation</a></li>
<li><a href="https://forge.chapril.org/Fab_Blab/freeDatas2HTML" target="_blank" title="accéder au dépôt GIT" rel="noopener" class="badge success sm-12 col">Git</a></li>
</ul>
</nav>
</header>
<aside>
<h4>Menu</h4>
<ul>
<li><a href="#installation">Installer FreeDatas2HTML</a></li>
<li><a href="#instance">Instancier la classe principale</a></li>
<li><a href="#setDatas">Fournir directement les données à parser</a></li>
<li><a href="#import">Importer les données à partir dune source distante</a></li>
<li><a href="#DOMElt">Définir lélément du DOM où seront affichées les données</a></li>
<li><a href="#parser">Parser les données</a></li>
<li><a href="#render">Adapter le code HTML généré pour afficher des données</a></li>
<li><a href="#compteur">Afficher un compteur</a></li>
<li><a href="#pagination">Paginer les données</a></li>
<li><a href="#filtres">Proposer des filtres pour les données</a></li>
<li><a href="#search">Proposer un moteur de recherche</a></li>
<li><a href="#classement">Permettre de classer les données affichées</a></li>
<li><a href="#fonctionClassement">Personnaliser la façon de classer les données</a></li>
<li><a href="#conclusion">Conclusion</a></li>
</ul>
</aside>
<article id="content">
<h2>Documentation FreeDatas2HTML</h2>
<h3 id="installation">Installer FreeDatas2HTML</h3>
<p>Pour linstant FreeDatas2HTML nest pas disponible sur NPM.<br />
Vous devez donc en récupérer une copie sur <a href="https://forge.chapril.org/Fab_Blab/freeDatas2HTML" rel="noopener" target="_blank">le dépôt GIT du projet</a>.<br />
Si vous travaillez en TypeScript, vous pouvez directement utiliser les fichiers présents dans le répertoire <a href="https://forge.chapril.org/Fab_Blab/FreeDatas2HTML/src/branch/master/src" rel="noopener" target="_blank">/src</a> et ignorer le sous-répertoire /build.<br />
Si vous travaillez en JavaScript, vous devez au contraire utiliser les scripts présents dans le répertoire <a href="https://forge.chapril.org/Fab_Blab/FreeDatas2HTML/src/branch/master/src/build" rel="noopener" target="_blank">/src/build</a>.</p>
<h3 id="instance">Instancier la classe principale</h3>
<p>Une fois les scripts présents dans le répertoire de votre projet, vous pouvez les importer comme nimporte quel module:<br />
<code>import { FreeDatas2HTML } from "./modules/FreeDatas2HTML";</code><br />
À supposer que les scripts soient situés dans le sous-répertoire FreeDatas2HTML du répertoire <em>modules</em> de votre projet.</p>
<p>Suivant ce que vous souhaitez faire, vous aurez peut-être besoin dimporter dautres classes, comme indiqué plus loin.</p>
<p>Ensuite, dans votre script, vous pouvez créer votre instance de manière classique:<br />
<code>const myConverter=new FreeDatas2HTML("CSV");</code></p>
<h4>Type de données</h4>
<p>Le premier argument du constructeur est obligatoire et vous permet dindiquer le format des données à parser, avec trois options possibles: <em>«CSV»</em>, <em>«JSON»</em>, <em>«HTML»</em>.</p>
<h3 id="setDatas">Fournir directement les données à parser</h3>
<p>Si vous avez déjà les données à parser sous la main, vous pouvez les fournir en deuxième argument du constructeur sous forme dune chaîne de caractère:<br />
<code>const myConverter=new FreeDatas2HTML("JSON", `[{ "name": "Doe", "firstname" : "John" },{ "name": "Doe", "firstname" : "Janie" }]`);</code></p>
<p>Mais vous pouvez très bien fournir ou modifier cette information après linstanciation:<br />
<code>myConverter.parser.datas2Parse=`[{ "name": "Doe", "firstname" : "John" },{ "name": "Doe", "firstname" : "Janie" }]`;</code></p>
<h3 id="import">Importer les données à partir dune source distante</h3>
<p>Le dernier argument, vous permet de passer une instance de la classe <em>RemoteSource</em> quil vous faudra au préalable avoir importée et déclarée:<br />
<code>import { FreeDatas2HTML, RemoteSource } from "./modules/FreeDatas2HTML";<br />
const mySource=new RemoteSource({ url:"https://www.example.com/datas.csv" });<br />
const myConverter=new FreeDatas2HTML("CSV","", mySource);</code></p>
<p>En fait, il sera accepté une instance de nimporte quelle classe validant linterface <em>RemoteSources</em> que vous pouvez retrouver déclarée dans le script <a href="https://forge.chapril.org/Fab_Blab/FreeDatas2HTML/src/branch/master/src/interfaces.ts" rel="noopener" target="_blank">interface.ts</a>.</p>
<p>Vous pouvez fournir des entêtes pour lappel à la source de données distantes:<br />
<code>mySource.headers=[ { key:"token", value:"1234" }, { key:"userName", value:"Toto" }];</code></p>
<p>Il vous est aussi possible de déclarer la propriété <em>XMLHttpRequest.withCredentials</em>:<br />
<code>mySource.withCredentials=true;</code><br />
<br />
Mais vous pouvez aussi fournir la source de données distante après linstanciation en utilisant le <em>setter</em>:<br />
<code>myConverter.parser.setRemoteSource({ url:"https://www.example.com/datas.csv" });</code></p>
<p>Dans ce cas limportation préalable de la classe <em>RemoteSource</em> est inutile.<br />
De nouveau, vous pouvez fournir des options:<br />
<code>myConverter.parser.setRemoteSource({ url:"https://www.example.com/datas.csv", headers:[{ key:"token", value:"1234" }],&nbsp;<code class="code-inner"><span class="nx">withCredentials</span>:true</code> });</code></p>
<h3 id="DOMElt">Définir lélément du DOM où seront affichées les données</h3>
<p>Ceci est facultatif, car vous pouvez très bien simplement vouloir parser les données.<br />
Mais si vous souhaitez que FreeDatas2HTML soccupe dafficher les données, vous pouvez indiquer l<em>id </em>de lélément de la page où les afficher:<br />
<code>myConverter.datasViewElt={ id:"myDatas" };</code><br />
Lélément doit exister dans la page, sans quoi le <em>setter</em> générera une erreur.</p>
<h3 id="parser">Parser les données</h3>
<p>Pour lancer le parsage, utilisez la méthode <em>run()</em> qui est asynchrone:<br />
<code>await myConverter.run();</code></p>
<p>En cas de succès du parsage, si l<em>id </em>de lélément du DOM devant recevoir les données est connu, elles seront automatiquement affichées dans la page.</p>
<p>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:<br />
<code>const fields=myConverter.fields; // format de sortie: string[], exemple: ["fistname", "name"]<br />
const datas=myConverter.datas; // format de sortie : {[index: string]:string}[], exemple: [{"firstname":"Janie", "name":"Doe"}, {"firstname":"John", "name":"Doe"}];</code><br />
Les formats de sortie sont les mêmes, quel que soit le format des données parsées.</p>
<h4>Tolérance aux erreurs de parsage</h4>
<p>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.<br />
Si vous souhaitez bloquer la suite quand cela arrive, il vous faut lindiquer avant de lancer le parsage:<br />
<code>myConverter.stopIfParseErrors=true;</code><br />
Par défaut, les erreurs de parsage sont tolérées.</p>
<h3>Adapter le rendu visuel des données</h3>
<p>Par défaut toutes les données trouvées seront affichées sous forme de tableau, sans classe CSS particulière:</p>
<p><code>&lt;table&gt;<br />
&nbsp;&lt;thead&gt;&lt;tr&gt;&lt;td&gt;firstname&lt;/td&gt;&lt;td&gt;name&lt;/td&gt;&lt;/tr&gt;&lt;/thead&gt;<br />
&nbsp;&lt;tbody&gt;<br />
&nbsp; &lt;tr&gt;&lt;td&gt;Janie&lt;/td&gt;&lt;td&gt;Doe&lt;/td&gt;&lt;/tr&gt;<br />
&nbsp; &lt;tr&gt;&lt;td&gt;John&lt;/td&gt;&lt;td&gt;Doe&lt;/td&gt;&lt;/tr&gt;<br />
&nbsp;&lt;/tbody&gt;<br />
&lt;/table&gt;</code></p>
<h4>Ne pas afficher tous les champs disponibles</h4>
<p>Si vous ne souhaitez pas afficher tous les champs trouvés dans votre fichier, vous pouvez indiquer ceux à garder:<br />
<code>myConverter.fields2Rend=[0,2]; // naffichera que le 1ᵉʳ et le 3ᵉ champ, la numérotation commençant à zéro.</code></p>
<p>Ce <em>setter</em> provoquera une erreur si vous fournissez un numéro de champ nexistant pas dans les données parsées.<br />
Vous pouvez par contre le déclarer à tout moment, pour prise en compte dès le prochain affichage.</p>
<p>Pour de nouveau afficher tous les champs (soit, revenir à la situation par défaut), il vous suffit de passer un tableau vide:<br />
<code>myConverter.fields2Rend=[];</code></p>
<h3 id="render">Adapter le code HTML généré pour afficher des données</h3>
<p>Pour spécifier le code HTML à générer, vous devez créer une instance de la classe <em>Render</em> ou dune autre classe validant linterface <em>DatasRenders</em> déclarée dans le script <a href="https://forge.chapril.org/Fab_Blab/FreeDatas2HTML/src/branch/master/src/interfaces.ts" rel="noopener" target="_blank">interface.ts</a>.</p>
<p>Dans le cas de la classe <em>Render</em>, il faut commencer par limporter et linstancier:<br />
<code>import { FreeDatas2HTML, Render } from "./modules/FreeDatas2HTML";</code><br />
<code></code><br />
<code>const myRender=new Render();</code></p>
<p>Et ensuite utiliser lattribut <em>settings</em> pour décrire ce que vous souhaitez obtenir:<br />
<code>myRender.settings=<br />
{<br />
&nbsp;&nbsp;&nbsp; allBegining:"&lt;h4&gt;Moi je préfère les listes aux tableaux!&lt;/h4&gt;",<br />
&nbsp;&nbsp;&nbsp; allEnding:"Pas vous?",<br />
&nbsp;&nbsp;&nbsp; linesBegining:"&lt;ul&gt;",<br />
&nbsp;&nbsp;&nbsp; linesEnding:"&lt;/ul&gt;",<br />
&nbsp;&nbsp;&nbsp; lineBegining:"&lt;li&gt;&lt;ul&gt;",<br />
&nbsp;&nbsp;&nbsp; lineEnding:"&lt;/ul&gt;&lt;/li&gt;",<br />
&nbsp;&nbsp;&nbsp; dataDisplaying:"&lt;li&gt;&lt;b&gt;#FIELDNAME :&lt;/b&gt; #VALUE&lt;/li&gt;",<br />
};</code></p>
<p>Dans ce cas, la configuration par défaut est écrasée par ce qui est fourni à <em>settings</em>.<br />
<a href="https://forge.chapril.org/Fab_Blab/FreeDatas2HTML/src/branch/master/src/interfaces.ts" rel="noopener" target="_blank">Consulter le type <em>DatasRendersSettings</em></a> pour voir tous les attributs disponibles.</p>
<p>Si vous souhaitez simplement modifier un des attributs, vous pouvez le faire ainsi:<br />
<code>myRender.settings.allBegining="&lt;table class='myTable'&gt;";</code><br />
Ici le tableau sera le même que précédément, seule la balise <em>&lt;table&gt;</em> sest vu ajouter une classe CSS.</p>
<p>Dans les deux cas, il faut ensuite fournir votre <em>Render</em> à votre instance de FreeDatas2HTML:<br />
<code>myConverter.datasRender=myRender;</code></p>
<h4>Besoin dun rendu complexe, fusionnant plusieurs champs?</h4>
<p>Il est possible dobtenir un rendu plus complexe, mixant les données venant de plusieurs champs.<br />
Cest par exemple le cas si vous souhaitez créer un lien dont lURL se trouve dans un champ et lancre dans un autre.</p>
<p>Ceci est possible via lextension <strong><em>MixedFieldsRender.ts</em></strong>. Cette documentation ne présente pas lusage de cette extension pour linstant, mais vous pouvez vous inspirer <a href="https://forge.chapril.org/Fab_Blab/FreeDatas2HTML/src/branch/master/src/demo/exampleWithMixedFields.ts" rel="noopener" target="_blank">du code utilisé par la page de démonstration de cette classe</a>.</p>
<h3 id="compteur">Afficher un compteur</h3>
<p>Si vous souhaitez afficher quelque part le nombre denregistrements, il vous suffit de fournir l<em>id </em>de lélément de votre page devant recevoir cette information:<br />
<code>myConverter.datasCounterElt={ id:"ndDatas" };</code></p>
<p>Ce compteur sera ensuite mis à jour à chaque actualisation des données, en prennant en compte les filtres activés par lutilisateur, mais en ignorant la pagination qui nest quune commodité de navigation.</p>
<p>Si vous souhaitez vous-mêmes actualiser laffichage de ce compteur, utilisez cette méthode:<br />
<code>myConverter.datasCounter2HTML();</code></p>
2022-03-04 17:19:47 +01:00
<h3 id="pagination">Paginer les données</h3>
2022-03-04 17:19:47 +01:00
<p>Par défaut, tous les enregistrements extraits de la source de données sont affichés à lemplacement prévu dans la page.<br />
Toutefois, vous pouvez les paginer et même proposer aux utilisateurs finaux de choisir le nombre de résultats à afficher par page.</p>
2022-03-04 17:19:47 +01:00
<p>Ceci est possible via la classe <em>Pagination</em> qui doit donc être importée et instanciée:<br />
<code>import { FreeDatas2HTML, Pagination } from "./modules/FreeDatas2HTML";</code><br />
<code></code><br />
<code>const myPagination=new Pagination(converter, { id:"pages" });</code></p>
2022-03-04 17:19:47 +01:00
<p>Ceci ne devant être fait qu<strong>après avoir importé vos données</strong>, qui sont nécessaires à la pagination.</p>
2022-03-04 17:19:47 +01:00
<p>Le 1ᵉʳ paramètre est votre instance de FreeDatas2HTML et le deuxième l<em>id </em>de lélément HTML où sera injecté le <em>SELECT</em> permettant de passer dune page à lautre.<br />
Un troisième paramètre peut vous permettre de personnaliser le texte dans le L<em>ABEL</em> de ce <em>SELECT</em>:<br />
<code>const myPagination=new Pagination(converter, { id:"pages" }, "Aller à la page :");</code><br />
Par défaut, il y sera affiché «Pages».</p>
2022-03-04 17:19:47 +01:00
<p>Une fois votre classe instanciée, vous pouvez proposer un choix de pagination aux utilisateurs finaux:<br />
<code>myPagination.options={ displayElement: { id:"paginationOptions" }, values: [10,20,50,100] , name: "Choix de pagination :" };</code><br />
Ici:</p>
2022-03-04 17:19:47 +01:00
<ul>
<li><em>displayElement</em> est l<em>id </em>de lélément de votre page où sera injecté le <em>SELECT</em> proposant les options</li>
<li><em>values</em>, les différentes valeurs de pagination proposées, qui doivent être des nombres entiers réels. Au besoin, ils seront dédoublonnés, mais laissés dans lordre fourni. Il doit y avoir au moins 2 valeurs distinctes.</li>
<li><em>name</em> le texte du <em>LABEL</em>. Sil nest pas fourni, la valeur par défaut est «Pagination».</li>
</ul>
2022-03-04 17:19:47 +01:00
<p>Vous pouvez aussi définir une valeur de pagination par défaut:<br />
<code>myPagination.selectedValue=10;</code><br />
Si des options de pagination sont renseignées, cette valeur doit faire partie de celles proposées ou bien <em>undefined</em> pour afficher toutes les données.</p>
2022-03-04 17:19:47 +01:00
<p>Puis il vous reste à fournir votre pagination à votre instance FreeDatas2HTML:<br />
<code>myConverter.pagination=myPagination;</code></p>
2022-03-04 17:19:47 +01:00
<p>Si vous proposez des options de pagination, vous devez lancer linjection du code HTML correspondant dans votre page:<br />
<code>myPagination.options2HTML();</code></p>
2022-03-04 17:19:47 +01:00
<p>Il y a une méthode similaire, <em>pages2HTML()</em>, pour injecter le code du <em>SELECT</em> permettant de changer de page.<br />
Mais vous navez pas à vous en occuper, car cest FreeDatas2HTML qui appelle cette méthode à chaque fois que laffichage des données est actualisé.<br />
Car suivant les filtres activés par lutilisateur, le nombre denregistrements peut changer et par conséquent le nombre de pages à proposer.<br />
Quand il y a moins de données affichées que le nombre maximum prévu par page, ce <em>SELECT</em> nest pas affiché.</p>
2022-03-04 17:19:47 +01:00
<h3 id="filtres">Proposer des filtres pour les données</h3>
2022-03-04 17:19:47 +01:00
<p>Les filtres sont des éléments <em>SELECT</em> listant, de manière&nbsp;classée et dédoublonnée, toutes les valeurs distinctes disponibles pour un champ.<br />
Le classement se fait par ordre «naturel», cest-à-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»…<br />
Pour des besoins particuliers, il vous est possible dutiliser votre propre fonction de classement, ce qui sera expliqué plus loin.</p>
2022-03-04 17:19:47 +01:00
<p>Si plusieurs filtres sont proposés à lutilisateur final, seuls les enregistrements validant tous les choix de lutilisateur seront affichés.</p>
2022-03-04 17:19:47 +01:00
<p>Pour ajouter un filtre, commencer par linclure dans votre script et créer une instance:<br />
<code>import { FreeDatas2HTML, Selector } from "./modules/FreeDatas2HTML";</code><br />
<code></code><br />
<code>const myFilter1=new Selector(myConverter, 3, { id:"filter1"});</code></p>
2022-03-04 17:19:47 +01:00
<p>Les trois premiers paramètres sont obligatoires:</p>
2022-03-04 17:19:47 +01:00
<ul>
<li>le premier est votre instance de FreeDatas2HTML</li>
<li>le deuxième correspond au numéro du champ utilisé pour ce filtre</li>
<li>le troisième est l<em>id </em>de lélément HTML dans lequel sera injecté la liste <em>SELECT</em>.</li>
</ul>
2022-03-04 17:19:47 +01:00
<p>Un quatrième paramètre facultatif permet dindiquer un séparateur, qui vous sera utile si un champ contient plusieurs valeurs pour un même enregistrement.<br />
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:<br />
<code>const myFilter2=new Selector(myConverter, 2, { id:"filter2"}, ";" );</code></p>
2022-03-04 17:19:47 +01:00
<p>Attention, <strong>vous devez dabord avoir parsé vos données avant de créer votre instance de Selector</strong>, car lexistence du champ fourni en paramètre est testé à cette étape.</p>
2022-03-04 17:19:47 +01:00
<p>Une fois votre instance créée, en attribut supplémentaire permettra à lutilisateur de sélectionner plusieurs valeurs dans la liste:<br />
<code>myFilter2.isMultiple=true;</code><br />
Ce nest 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é.</p>
2022-03-04 17:19:47 +01:00
<p>Linstanciation 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:<br />
<code>const selectDatas=myFilter1.selectedValues;</code><br />
Il sagit dun tableau de chaînes de caractères. Par exemple pour des années:<br />
<code>["1998", "2000", "2005" …]</code></p>
2022-03-07 18:13:45 +01:00
<p>Une fois la configuration terminée, vous pouvez injecter votre liste dans la page via le code suivant:<br />
<code>myFilter.filter2HTML();</code></p>
2022-03-07 18:13:45 +01:00
<p>Par défaut, le <em>label</em> affiché devant la liste sera le nom du champ concerné, tel que présent dans les données traitées.<br />
Si vous souhaitez afficher un autre texte, vous pouvez le passer en paramètre:<br />
<code>myFilter.filter2HTML("Choisissez une valeur :");</code></p>
2022-03-07 18:13:45 +01:00
<p>Pour que votre filtre soit effectivement actif, il vous faut ensuite le transmettre à votre instance de FreeDatas2HTML.<br />
Vous pouvez passer tous vos filtres en une seule fois:<br />
<code>myConverter.datasFilters=[myFilter1, myFilter2, myFilter3];</code><br />
Il sera en fait acceptée toute instance dune classe respectant linterface Filters <a href="https://forge.chapril.org/Fab_Blab/FreeDatas2HTML/src/branch/master/src/interfaces.ts" rel="noopener" target="_blank">décrite dans le script interface.ts</a>.</p>
2022-03-07 18:13:45 +01:00
<h3 id="search">Proposer un moteur de recherche</h3>
2022-03-07 18:13:45 +01:00
<p>Un moteur de recherche est en fait un filtre comme les autres ou presque!<br />
Effectivement, dans les deux cas il est proposé à lutilisateur final de filtrer les données suivant son choix, quil pourra effectuer librement dans un moteur de recherche ou de manière contrainte dans une liste de sélections.</p>
2022-03-07 18:13:45 +01:00
<p>Les deux classes <em>Filter</em> et <em>SearchEngine</em> implémentent dailleurs la même interface: <em>Filters</em>.<br />
Et comme dit plus haut, toute instance dune classe validant cette interface sera acceptée comme filtre par FreeDatas2HTML.</p>
2022-03-07 18:13:45 +01:00
<p>Bref pour ajouter un moteur de recherche, il faut de nouveau inclure la classe et linstancier:<br />
<code>import { FreeDatas2HTML, SearchEngine } from "./modules/FreeDatas2HTML";<br />
<br />
const mySearch=new SearchEngine(myConverter, { id:"search" });</code></p>
2022-03-07 18:13:45 +01:00
<p>Les deux premiers paramètres sont obligatoires:</p>
2022-03-07 18:13:45 +01:00
<ul>
<li>le premier est de nouveau votre instance de FreeDatas2HTML</li>
<li>le second correspond à l<em>id </em>de lélément de votre document dans lequel le moteur de recherche sera injecté.</li>
</ul>
2022-03-07 18:13:45 +01:00
<h4>Définir les champs à utiliser pour votre recherche</h4>
2022-03-07 18:13:45 +01:00
<p>Un troisième paramètre vous permet de préciser la liste des champs dans lesquels la saisie de lutilisateur sera recherchée.<br />
Par exemple, pour limiter la recherche aux troisième et quatrième champs:<br />
<code>const mySearch=new SearchEngine(myConverter, { id:"search" }, [2,3]);</code></p>
2022-03-07 18:13:45 +01:00
<p>Par défaut la recherche se fait donc dans tous les champs présents dans les données, qui ne sont pas forcément affichés.<br />
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…</p>
2022-03-07 18:13:45 +01:00
<h4>Personnaliser lapparence du moteur de recherche</h4>
2022-03-07 18:13:45 +01:00
<p>Vous pouvez ensuite personnaliser lapparence de votre moteur de recherche via certains attributs.</p>
2022-03-07 18:13:45 +01:00
<p>Le texte du <em>label</em> du champ de saisie:<br />
<code>mySearch.label="Votre recherche :"; // par défaut vide, il ny aura alors pas de &lt;label&gt;</code></p>
2022-03-07 18:13:45 +01:00
<p>Le texte du bouton lançant la recherche:<br />
<code>mySearch.btnTxt="Va chercher!"; // par défaut: Search</code></p>
2022-03-07 18:13:45 +01:00
<p>Ou encore le <em>placeholder</em> saffichant dans le champ de saisie:<br />
<code>mySearch.placeholder="Saisir votre recherche"; // par défaut vide ou «Please enter at least NB characters. », sil y a un nombre minimum de caractères pour lancer la recherche automatique.</code></p>
2022-03-07 18:13:45 +01:00
<h4>Lancement automatique de la recherche?</h4>
2022-03-07 18:13:45 +01:00
<p>Pour lancer la recherche dès la saisie:<br />
<code>mySearch.automaticSearch=true; // par défaut false</code><br />
En fixant éventuellement au nombre minimum de caractères:<br />
<code>mySearch.nbCharsForSearch=2; // si loption 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.</code></p>
2022-03-07 18:13:45 +01:00
<p>Ce nombre de caractères minimum ne concerne pas le bouton lançant la recherche.<br />
En mode recherche automatique lorsque le champ de saisie est vidé par lutilisateur, laffichage est actualisé pour ne plus prendre en compte ce filtre.</p>
2022-03-07 18:13:45 +01:00
<h4>Recherche stricte ou «lâche»?</h4>
2022-03-07 18:13:45 +01:00
<p>Sachez que <strong>par défaut la recherche de la valeur se fait de manière «lâche», cest-à-dire en ignorant la casse, les accents ou encore les caractères spéciaux.</strong><br />
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 quun enregistrement soit affiché en résultat.</p>
2022-03-07 18:13:45 +01:00
<p>En effet, les utilisateurs prennent rarement la peine de saisir lorthographe exacte de ce quils cherchent.<br />
Mais cela peut créer des faux positifs et si vous souhaitez une recherche plus stricte, lattribut «searchMode» vous permet de préciser votre besoin:</p>
2022-03-07 18:13:45 +01:00
<ul>
<li><code>mySearch.searchMode.accentOff=true; // la recherche prendra en compte les accents.</code></li>
<li><code>mySearch.searchMode.caseOff=true; // la recherche prendra en compte la casse.</code></li>
<li><code>mySearch.searchMode.separatedWords=false; // même si elle contient des espaces, lexpression saisie sera cherchée en entier.</code></li>
<li><code>mySearch.searchMode.specialCharsOff=true; // la recherche prendra en compte les éventuels caractères spéciaux&nbsp;(*) saisis.</code></li>
<li><code>mySearch.searchMode.specialCharsWhiteList="#@%"; // dans le cas où loption précédente est à «false», les caractères listés dans la chaîne fournie seront néanmoins pris en compte, cest-à-dire ici "#", "@" et "%".</code></li>
</ul>
2022-03-07 18:13:45 +01:00
<p>(*) Seuls les caractères de lalphabet 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é.</p>
2022-03-07 18:13:45 +01:00
<p>Évidemment toutes les options précédentes peuvent être passées en une seule fois:<br />
<code>mySearch.searchMode={ accentOff=true, caseOff=true, separatedWords=false, specialCharsOff=true };</code></p>
2022-03-07 18:13:45 +01:00
<h4>Intégration à la page et activation</h4>
2022-03-07 18:13:45 +01:00
<p>Une fois configuré, vous pouvez afficher votre moteur de recherche de la même manière que pour les filtres précédents:<br />
<code>mySearch.filter2HTML();</code></p>
2022-03-07 18:13:45 +01:00
<p>Sans oublier de le transmettre à votre instance FreeDatas2HTML, sans quoi il sera inactif:<br />
<code>myConverter.datasFilters=[mySearch];</code></p>
2022-03-07 18:13:45 +01:00
<p>Ce qui peut être fait conjointement à vos autres filtres:<br />
<code>myConverter.datasFilters=[myFilter1, myFilter2, mySearch];</code></p>
2022-03-07 18:13:45 +01:00
<h3 id="classement">Permettre de classer les données affichées</h3>
2022-03-07 18:13:45 +01:00
<p>Un dernier outil va donner la possibilité à vos utilisateurs de classer les données affichées via le champ de son choix.<br />
Pour ce faire, <strong>il est nécessaire que le rendu que vous avez choisi propose des entêtes de colonnes</strong>, ce qui est typiquement le cas des tableaux HTML contenant des balises &lt;TH&gt;.<br />
Lutilisateur pourra ainsi cliquer sur lentête dune colonne pour classer les données dans un sens, puis de nouveau cliquer pour les classer dans lautre sens, etc.</p>
2022-03-07 18:13:45 +01:00
<p>Pour utiliser cet outil, comme dhabitude, il vous faut commencer par inclure sa classe et linstancier pour chaque champ/colonne ouverte au classement:<br />
<code>import { FreeDatas2HTML, SortingField } from "./modules/FreeDatas2HTML";<br />
<br />
const mySortingField1=new SortingField(myConverter, 0);</code><br />
<code>const mySortingField2=new SortingField(myConverter, 3);</code></p>
2022-03-07 18:13:45 +01:00
<p>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…<br />
Un troisième paramètre facultatif, vous permet de désigner <a href="https://www.w3.org/Style/css3-selectors-updates/WD-css3-selectors-20010126.fr.html#selectors" rel="noopener" target="_blank" title="W3C">le sélecteur CSS</a> à utiliser pour trouver les entêtes dans votre code HTML (par défaut, «TH»):<br />
<code>const mySortingField1=new SortingField(myConverter, 0, "td.fieldNames");</code><br />
Ce sélecteur CSS doit retourner le même nombre déléments quil y a de champs affichés dans votre page, sans quoi il y aura une erreur.</p>
2022-03-07 18:13:45 +01:00
<p>Une fois tous vos champs de classement instanciés, il vous faut les transmettre à votre instance FreeDatas2HTML:<br />
<code>myConverter.datasSortingFields=[<code>mySortingField1, mySortingField2</code>];</code></p>
2022-03-07 18:13:45 +01:00
<p>Il est préférable de les transmettre avant le 1ᵉʳ affichage, car cest FreeDatas2HTML qui soccupera de rendre ses éléments cliquables.<br />
Dans le cas contraire, vous pouvez toujours actualiser laffichage après coup:<br />
<code>myConverter.refreshView();</code></p>
2022-03-07 18:13:45 +01:00
<p>Une fois les liens de classement installés, vous navez plus à vous en occuper.<br />
Toutefois si vous souhaitez intervenir, lattribut <em>order</em> est disponible:<br />
<code>mySortingField1.order="desc"; // accepte "asc", "desc" ou undefined.</code></p>
2022-03-07 18:13:45 +01:00
<p>À noter quune extension est proposée pour vous permettre de créer des liens de classement, même quand vous navez pas prévu dentêtes dans le rendu de vos données.<br />
Il sagit de la classe <strong><i>SortingFieldsStandAlone</i></strong> qui nest pas documentée ici pour linstant. Mais vous pouvez <a href="https://forge.chapril.org/Fab_Blab/freeDatas2HTML/src/branch/master/src/demo/exampleWithUL.ts" target="_blank">étudier le code dune des pages de démonstration lutilisant</a>.</p>
2022-03-07 18:13:45 +01:00
<h3 id="fonctionClassement">Personnaliser la façon de classer les données</h3>
2022-03-07 18:13:45 +01:00
<p>Comme déjà indiqué, par défaut les classements se font de manière «naturelle», cest-à-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.</p>
2022-03-07 18:13:45 +01:00
<p>Toutefois, la façon de classer certaines données doit être explicitée. Cest par exemple le cas de la 4ᵉ colonne <a href="/withCSV.html" target="_blank" title="accéder à cette page">de la page de démonstration listant des éléments chimiques</a>. Vous y trouver des textes «Inexistant», «Traces» ou encore des opérateurs de comparaison comme&nbsp;« &gt; 1 et &lt; 100000». Comment faire pour trier ces données?</p>
2022-03-07 18:13:45 +01:00
<p>Dans ce cas, il vous faut fournir une fonction personnalisée de classement à votre instance de FreeDatas2HTML. Cette fonction doit <a href="https://developer.mozilla.org/fr/docs/Web/JavaScript/Reference/Global_Objects/Array/sort" rel="noopener" target="_blank" title="Documentation sur MDN">être compatible avec la fonction sort() de JavaScript</a>.<br />
Voici par exemple, la fonction utilisée dans la page de démonstration:<br />
<code>const mySort=(a: any, b: any, order: "asc"|"desc" = "asc") =&gt;<br />
{<br />
&nbsp;&nbsp;&nbsp; const values=[ "&gt; 100000", "&gt; 1 et &lt; 100 000", "≤ 1",&nbsp; "Traces", "Inexistant"];<br />
&nbsp;&nbsp;&nbsp; if(order === "desc")<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; values.reverse();<br />
&nbsp;&nbsp;&nbsp; if(values.indexOf(a) &gt; values.indexOf(b))<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; return -1;<br />
&nbsp;&nbsp;&nbsp; else if(values.indexOf(a) &lt; values.indexOf(b))<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; return 1;<br />
&nbsp;&nbsp;&nbsp; else<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; return 0;<br />
};</code></p>
2022-03-07 18:13:45 +01:00
<p>Une fois toutes vos fonctions de classement définies, il vaut faut les associer aux champs concernés de vos données:<br />
<code>myConverter.datasSortingFunctions=[{ datasFieldNb:4, sort:mySort }, { datasFieldNb:5, sort:mySort2 }];</code></p>
2022-03-07 18:13:45 +01:00
<p>Il est important de les associer à votre instance avant de déclarer toute autre fonctionnalité en ayant besoin: filtres <em>SELECT</em>, colonnes de classement…</p>
2022-03-07 18:13:45 +01:00
<h3 id="conclusion">Conclusion</h3>
2022-03-04 17:19:47 +01:00
<p>Cette documentation nest sans doute pas exhaustive, mais vous donne les principales clés pour intégrer FreeDatas2HTML à votre projet.</p>
2022-03-04 17:19:47 +01:00
<p>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 laffichage, les filtres, la pagination, etc. tout en continuant à bénéficier du reste du code de FreeDatas2HTML.</p>
</article>
<footer><p>Design: <a href="https://www.getpapercss.com" target="_blank">PaperCSS</a> | <a href="/mentions-legales.html">Contact et mentions légales</a>.</p></footer>
</body>
</html>