快捷插件可供开发人员使用,将常用或复杂的 UQL 查询实现到插件中,或探索实验性和扩展性的功能。开发人员可灵活使用此功能来自定义 UQL 查询,或根据特定需求扩展 Ultipa Manager 的功能。
所有的快捷插件均在快捷菜单下进行管理,用户可以直接在 UQL 编辑器或任何嵌入了插件的网页中使用插件。
新建快捷插件
在快捷菜单下添加快捷插件。以下是编辑页面:
1. 脚本书写
在左侧的命令行窗口书写脚本,示例如下:
async function PluginDo(formData = {}, client) {
const { node_schema, limit } = formData;
const response = await client.uql(
`find().nodes({@${node_schema || 'order'}}) as nodes
return nodes{*} limit ${limit || 10}`
);
return response;
在 find().nodes()
UQL 查询语句中使用两个自定义变量 node_schema
和 limit
,其中 node_schema
的默认值为 order,limit
的默认值为 10。
2. 参数表配置
在参数表配置窗口中添加变量字段构建变量输入表单,以下是每个变量字段的配置项:
项目 |
内容 | 规范 |
---|---|---|
Variable | 变量名 | 必须于脚本里的变量名保持一致 |
Label | 自定义变量字段标签 | / |
Placeholder | 变量字段占位内容d | / |
Type | 变量字段类型 | 部分类型有进一步的配置项 |
3. 测试快捷插件
点击测试旁的齿轮图标能打开变量输入表单。按需填写表单后,可以直接运行 UQL 语句或保存变量设置以供测试。该 UQL 语句会在当前图集上运行,结果显示在结果预览窗口中。
4. 设置和分享
点击默认的快捷插件名称 My Plugin 旁的配置图标,编辑名称和缩略图。将 iframe 代码嵌入到其他网页中后,可以在到期前在该网页中使用快捷插件,代码中的链接也可以直接在浏览器中打开。
使用快捷插件
UQL 编辑器可以在编辑器和快捷插件之间进行切换:
选择一个快捷插件后,相应的变量输入表单就会出现:
用户可以根据自己的喜好自定义快捷插件的排列方式,包括重新排序或将特定的快捷方式固定在最前面。
导入快捷插件
将以下文件放在同一个文件夹里,并将文件夹压缩为 ZIP 文件后上传到 Ultipa Manager,文件名将用作快捷插件名称。
内容 | 文件名和类型 | 规范 |
---|---|---|
脚本 | code.js | 必须 |
表单配置 | form.json | 必须 |
缩略图 | image.png | 可选,建议尺寸:180px*180px |
建议从 Ultipa Manager 导出一个快捷插件并将其用作模板,再进行所需的修改。任何对文件名或类型的修改都会导致导入失败。
如需同时导入多个快捷插件,请将多个快捷插件的文件夹同时压缩进同一个 ZIP 文件后上传到 Ultipa Manager。