Funktionshilfe

Den Reiter Funktionshilfe gibt es seit Version 3.0, den Syntaxhilfe-Tooltip der Editoren von Ninox seit Version 3.1. Ab Version 3.2.0 (Beta) tritt der Tooltip hinter die Autovervollständigungsliste zurück.

Der Reiter Funktionshilfe dokumentiert, was Sie in Ihren Formeln schreiben können: die Funktionen von Ninox, die von Ninext hinzugefügten und die globalen Funktionen Ihrer eigenen Datenbank. In den Skript-Editoren von Ninox gibt ein Syntaxhilfe-Tooltip das Wesentliche genau dort an, wo Sie schreiben.

Der Reiter ist den Administratoren vorbehalten. Er zeigt nur sein Symbol, eine Schriftrolle, nach dem Reiter Schema-Übersicht; sein Name erscheint, wenn Sie mit der Maus darüberfahren. Der Reiter und der Tooltip lassen sich in den Ninext Einstellungen ausschalten, Abschnitt „Zusätzliche Werkzeuge“: Interaktive Hilfe.

Der Reiter Funktionshilfe beim Eintrag von callNinoxFunction, Kategorie ★ Ninext

Eine Funktion wählen

Oben im Reiter hat die Auswahl zwei Bereiche, wie die von Felder & Formeln: links die Kategorien, rechts die Funktionen. Tippen Sie einige Buchstaben in den rechten Bereich: Die Liste behält nur die Funktionen, die sie enthalten. Vor jeder Funktion steht das Symbol des Typs, den sie zurückgibt.

Die Liste vereint drei Quellen:

KategorieInhalt
★ NinextWas Ninext der Sprache hinzufügt: callNinoxFunction, Native JS (#{ … }#), Badges, die Ereignisse der Ansichtsfelder und der Buttons, onNinextLoaded, die KI-Aufgaben.
★ Global functionsDie globalen Funktionen Ihrer Datenbank, aus ihrem globalen Code gelesen.
Kategorien von Ninox (Aggregation, Date, Text …)Die Funktionen von Ninox und die Schlüsselwörter seiner Sprache (select, let, if …).

Die beiden mit einem Stern markierten Kategorien stehen an erster Stelle, auf blassorangem Hintergrund; die Kategorien von Ninox folgen in alphabetischer Reihenfolge. Die Funktionen von Ninext werden in der Sprache von Ninox beschrieben (auf Englisch bei einer Sprache, die Ninext nicht kennt); die von Ninox werden auf Englisch beschrieben.

Die Einträge der KI-Aufgaben (aiTaskStart, aiTaskStatus, aiTaskCancel und „AI Tasks“) stehen in der Liste, sind aber noch nicht nutzbar: Sie beruhen auf dem Server ninext.fr, der noch nicht geöffnet ist.

Was ein Eintrag zeigt

  • Als Titel der Name der Funktion und der Typ, den sie zurückgibt, dann ihre Beschreibung.
  • Ihre Signaturen („Signatures“): jede Art, sie aufzurufen, mit ihren Parametern und deren Typ. Bei einem Schlüsselwort oder einer Ergänzung von Ninext ist es ihre Syntax („Syntax“).
  • Beispiele („Example“ oder „Examples“), eingefärbt wie im Editor von Ninox.
  • Bei einer globalen Funktion ihr vollständiger Code („Script“), mit Zeilennummern, samt dem Kommentar davor.
  • Ein Link 📖 Documentation zur Seite der Funktion in der Dokumentation von Ninox oder in der von Ninext (nicht bei einer globalen Funktion).
  • Die Links „See Also“ zu verwandten Funktionen. Nach einem solchen Sprung führt die Schaltfläche ← links vom Titel zum vorherigen Eintrag zurück.

Wenn Sie mit der Maus darüberfahren, zeigen jede Signatur, jedes Beispiel und der Code eine Kopierschaltfläche. Die Überschriften des Eintrags („Signatures“, „Syntax“, „Examples“, „Script“, „See Also“) bleiben auf Englisch, unabhängig von der Sprache.

Der Schalter Interaktive Hilfe

Unter der Auswahl, rechts, schaltet der Schalter Interaktive Hilfe den Syntaxhilfe-Tooltip in den Editoren von Ninox ein oder aus. Er ist standardmäßig eingeschaltet. Sein Zustand wird von Ihrem Browser gespeichert: Er gilt für alle in diesem Browser geöffneten Datenbanken, und nur dort.

Verwechseln Sie ihn nicht mit der gleichnamigen Einstellung der Ninext Einstellungen: Ausgeschaltet entfernt diese Einstellung den Reiter und den Tooltip für alle Administratoren der Datenbank.

Der Syntaxhilfe-Tooltip

Setzen Sie in einem Skript-Editor von Ninox den Cursor auf den Namen einer Funktion – von Ninox, von Ninext oder eine globale Funktion der Datenbank – oder auf ein Schlüsselwort: Unter dem Cursor öffnet sich ein Tooltip. Er zeigt die Signatur, die Beschreibung und ein Beispiel. Er schließt sich, wenn der Cursor den Namen verlässt.

  • Hat die Funktion mehrere Signaturen, wechseln die Pfeile ‹ und › oder die Punkte dazwischen von einer zur anderen.
  • Die Schaltfläche in Form einer Schriftrolle oben rechts im Tooltip zeigt den vollständigen Eintrag der Funktion im Reiter Funktionshilfe an und schließt den Tooltip.
  • Der Tooltip tritt zurück, solange die Autovervollständigungsliste von Ninox geöffnet ist, und während einer Textauswahl.

In der Konsole öffnet sich derselbe Tooltip, wenn der Cursor innerhalb eines Namens steht; er informiert auch über die lokalen Variablen, die Felder der Tabelle des Kontexts und die Schlüsselwörter. Während Sie die Argumente einer Funktion eingeben, erscheint außerdem über dem Cursor eine Syntaxführung, mit dem aktuellen Parameter hervorgehoben; diese bleibt neben der Autovervollständigungsliste sichtbar. Die Tooltips der Konsole hängen weder von diesem Schalter noch von der Einstellung Interaktive Hilfe ab.