Aide aux fonctions
L'onglet Aide aux fonctions existe depuis la version 3.0 ; la bulle d'aide à la syntaxe des éditeurs de Ninox, depuis la version 3.1. À partir de la version 3.2.0 (bêta), la bulle s'efface devant la liste d'autocomplétion.
L'onglet Aide aux fonctions documente ce que vous pouvez écrire dans vos formules : les fonctions de Ninox, celles que Ninext ajoute, et les fonctions globales de votre propre base. Dans les éditeurs de script de Ninox, une bulle d'aide à la syntaxe en donne l'essentiel à l'endroit même où vous écrivez.
L'onglet est réservé aux administrateurs. Il n'affiche que son icône, un parchemin, après l'onglet Aperçu du schéma ; son nom apparaît au survol. L'onglet et la bulle se désactivent dans les Paramètres Ninext, section « Outils supplémentaires » : Aide interactive.
Choisir une fonction
En haut de l'onglet, le sélecteur a deux zones, comme celui de Champs & Formules : à gauche les catégories, à droite les fonctions. Tapez quelques lettres dans la zone de droite : la liste ne garde que les fonctions qui les contiennent. Chaque fonction est précédée de l'icône du type de valeur qu'elle renvoie.
La liste réunit trois sources :
| Catégorie | Contenu |
|---|---|
| ★ Ninext | Ce que Ninext ajoute au langage : callNinoxFunction, Native JS (#{ … }#), Badges, les événements des champs vue et des boutons, onNinextLoaded, les tâches IA. |
| ★ Global functions | Les fonctions globales de votre base, lues dans son code global. |
| Catégories de Ninox (Aggregation, Date, Text…) | Les fonctions de Ninox, et les mots-clés de son langage (select, let, if…). |
Les deux catégories marquées d'une étoile viennent en tête, sur fond orangé pâle ; les catégories de Ninox suivent, par ordre alphabétique. Les fonctions de Ninext sont décrites dans la langue de Ninox (en anglais pour une langue que Ninext ne connaît pas) ; celles de Ninox sont décrites en anglais.
Les entrées des tâches IA (aiTaskStart, aiTaskStatus, aiTaskCancel et « AI Tasks ») figurent dans la liste, mais ne servent pas encore : elles reposent sur le serveur ninext.fr, qui n'est pas encore ouvert.
Ce que montre une fiche
- En titre, le nom de la fonction et le type de valeur qu'elle renvoie, puis sa description.
- Ses signatures (« Signatures ») : chaque façon de l'appeler, avec ses paramètres et leur type. Pour un mot-clé ou un ajout de Ninext, c'est sa syntaxe (« Syntax »).
- Des exemples (« Example » ou « Examples »), colorés comme dans l'éditeur de Ninox.
- Pour une fonction globale, son code complet (« Script »), lignes numérotées, avec le commentaire qui la précède.
- Un lien 📖 Documentation vers la page de la fonction dans la documentation de Ninox ou dans celle de Ninext (pas pour une fonction globale).
- Les liens « See Also » vers les fonctions voisines. Après un tel saut, le bouton ←, à gauche du titre, ramène à la fiche précédente.
Au survol, chaque signature, chaque exemple et le code montrent un bouton de copie. Les intitulés de la fiche (« Signatures », « Syntax », « Examples », « Script », « See Also ») restent en anglais, quelle que soit la langue.
L'interrupteur Aide interactive
Sous le sélecteur, à droite, l'interrupteur Aide interactive allume ou éteint la bulle d'aide à la syntaxe dans les éditeurs de Ninox. Il est allumé par défaut. Son état est retenu par votre navigateur : il vaut pour toutes les bases ouvertes dans ce navigateur, et seulement là.
Ne le confondez pas avec le réglage du même nom des Paramètres Ninext : éteint, ce réglage retire l'onglet et la bulle pour tous les administrateurs de la base.
La bulle d'aide à la syntaxe
Dans un éditeur de script de Ninox, posez le curseur sur le nom d'une fonction — de Ninox, de Ninext, ou une fonction globale de la base — ou sur un mot-clé : une bulle s'ouvre sous le curseur. Elle donne la signature, la description et un exemple. Elle se referme quand le curseur quitte le nom.
- Quand la fonction a plusieurs signatures, les flèches ‹ et ›, ou les points placés entre elles, passent de l'une à l'autre.
- Le bouton en forme de parchemin, en haut à droite de la bulle, affiche la fiche complète de la fonction dans l'onglet Aide aux fonctions, et referme la bulle.
- La bulle s'efface tant que la liste d'autocomplétion de Ninox est ouverte, et pendant une sélection de texte.
Dans la Console, la même bulle s'ouvre quand le curseur est à l'intérieur d'un nom ; elle renseigne aussi sur les variables locales, sur les champs de la table du contexte et sur les mots-clés. Pendant que vous tapez les arguments d'une fonction, un guide de syntaxe s'affiche en outre au-dessus du curseur, le paramètre en cours mis en évidence ; celui-là reste affiché à côté de la liste d'autocomplétion. Les bulles de la Console ne dépendent ni de cet interrupteur ni du réglage Aide interactive.