Справка по функциям
Вкладка «Справка по функциям» существует начиная с версии 3.0; подсказка по синтаксису в редакторах Ninox — начиная с версии 3.1. Начиная с версии 3.2.0 (бета) подсказка уступает место списку автодополнения.
Вкладка Справка по функциям описывает то, что вы можете писать в формулах: функции Ninox, функции, которые добавляет Ninext, и глобальные функции вашей собственной базы. В редакторах скриптов Ninox подсказка по синтаксису даёт самое главное прямо там, где вы пишете.
Вкладка доступна только администраторам. На ней виден лишь её значок — свиток — после вкладки Обзор схемы; название появляется при наведении. Вкладка и подсказка отключаются в Настройках Ninext, раздел «Дополнительные инструменты»: Интерактивная справка.
Выбор функции
В верхней части вкладки селектор состоит из двух областей, как на вкладке Поля и формулы: слева — категории, справа — функции. Введите несколько букв в правой области: в списке останутся только функции, которые их содержат. Перед каждой функцией стоит значок типа возвращаемого ею значения.
Список объединяет три источника:
| Категория | Содержимое |
|---|---|
| ★ Ninext | То, что Ninext добавляет в язык: callNinoxFunction, Native JS (#{ … }#), Badges, события полей-представлений и кнопок, onNinextLoaded, задачи ИИ. |
| ★ Global functions | Глобальные функции вашей базы, прочитанные из её глобального кода. |
| Категории Ninox (Aggregation, Date, Text…) | Функции Ninox и ключевые слова его языка (select, let, if…). |
Две категории, отмеченные звёздочкой, идут первыми, на бледно-оранжевом фоне; за ними в алфавитном порядке следуют категории Ninox. Функции Ninext описаны на языке Ninox (на английском — для языка, который Ninext не знает); функции Ninox описаны на английском.
Пункты задач ИИ (aiTaskStart, aiTaskStatus, aiTaskCancel и «AI Tasks») есть в списке, но пока не работают: они опираются на сервер ninext.fr, который ещё не открыт.
Что показывает карточка
- В заголовке — имя функции и тип возвращаемого ею значения, затем её описание.
- Её сигнатуры («Signatures»): все способы её вызова, с параметрами и их типами. Для ключевого слова или дополнения Ninext — его синтаксис («Syntax»).
- Примеры («Example» или «Examples»), раскрашенные, как в редакторе Ninox.
- Для глобальной функции — её полный код («Script») с пронумерованными строками и предшествующим ей комментарием.
- Ссылка 📖 Documentation на страницу функции в документации Ninox или Ninext (кроме глобальной функции).
- Ссылки «See Also» на родственные функции. После такого перехода кнопка ← слева от заголовка возвращает к предыдущей карточке.
При наведении у каждой сигнатуры, каждого примера и у кода появляется кнопка копирования. Заголовки разделов карточки («Signatures», «Syntax», «Examples», «Script», «See Also») остаются на английском, каков бы ни был язык.
Переключатель «Интерактивная справка»
Под селектором, справа, переключатель Интерактивная справка включает или выключает подсказку по синтаксису в редакторах Ninox. По умолчанию он включён. Его состояние запоминает ваш браузер: оно действует для всех баз, открытых в этом браузере, и только там.
Не путайте его с одноимённой настройкой в Настройках Ninext: выключенная, эта настройка убирает вкладку и подсказку для всех администраторов базы.
Подсказка по синтаксису
В редакторе скриптов Ninox поставьте курсор на имя функции — Ninox, Ninext или глобальной функции базы — или на ключевое слово: под курсором откроется подсказка. Она показывает сигнатуру, описание и пример. Она закрывается, когда курсор покидает имя.
- Когда у функции несколько сигнатур, стрелки ‹ и › или точки между ними переключают их.
- Кнопка в виде свитка в правом верхнем углу подсказки показывает полную карточку функции на вкладке Справка по функциям и закрывает подсказку.
- Подсказка скрывается, пока открыт список автодополнения Ninox, и во время выделения текста.
В Консоли та же подсказка открывается, когда курсор находится внутри имени; она также даёт сведения о локальных переменных, о полях таблицы контекста и о ключевых словах. Кроме того, пока вы вводите аргументы функции, над курсором показывается памятка по синтаксису с выделенным текущим параметром; она остаётся на экране рядом со списком автодополнения. Подсказки Консоли не зависят ни от этого переключателя, ни от настройки Интерактивная справка.