函数帮助

函数帮助标签页自 3.0 版起提供;Ninox 编辑器中的语法帮助气泡自 3.1 版起提供。自 3.2.0 版(测试版)起,气泡会让位于自动补全列表。

函数帮助标签页介绍您可以在公式中书写的内容:Ninox 的函数、Ninext 添加的函数,以及您自己数据库中的全局函数。在 Ninox 的脚本编辑器中,语法帮助气泡会在您书写的位置直接给出要点。

此标签页仅供管理员使用。它只显示一个图标——卷轴,位于架构概览标签页之后;鼠标悬停时会显示其名称。可以在 Ninext 设置的“其他工具”部分中停用该标签页和气泡:交互式帮助。

函数帮助标签页中 callNinoxFunction 的说明卡片,类别为 ★ Ninext

选择函数

在标签页顶部,选择器分为两个区域,与字段与公式中的选择器一样:左侧是类别,右侧是函数。在右侧区域输入几个字母:列表只保留包含这些字母的函数。每个函数前面都有表示其返回值类型的图标。

列表汇集了三种来源:

类别内容
★ NinextNinext 为语言添加的内容:callNinoxFunction、原生 JS(#{ … }#)、徽章、视图字段和按钮的事件、onNinextLoaded、AI 任务。
★ Global functions您数据库中的全局函数,从其全局代码中读取。
Ninox 的类别(Aggregation、Date、Text……)Ninox 的函数,以及其语言的关键字(select、let、if……)。

两个带星号的类别排在最前面,背景为浅橙色;其后是 Ninox 的类别,按字母顺序排列。Ninext 的函数以 Ninox 所用的语言介绍(如果 Ninext 不支持该语言,则用英语);Ninox 的函数则以英语介绍。

AI 任务的条目(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 的自动补全列表处于打开状态,或正在选择文本,气泡就会隐藏。

在控制台中,当光标位于某个名称内部时,也会打开同样的气泡;它还会提供关于局部变量、上下文表的字段以及关键字的信息。在您输入函数参数时,光标上方还会显示一个语法指南,当前参数以高亮显示;这个指南会一直显示在自动补全列表旁边。控制台中的气泡既不取决于这个开关,也不取决于交互式帮助设置。