3.1 KiB
3.1 KiB
JNPF 门户 (Portal) 开发指南
可视化门户是 JNPF 低代码平台的核心功能模块,支持通过拖拽配置快速构建数据看板。本文档提供完整的开发参考。
文档索引
| 文档 | 说明 |
|---|---|
| README.md | 本文档,速查入口 |
| 01-overview.md | 门户概述、核心概念 |
| 02-component-types.md | 21种组件类型详解 |
| 03-api-reference.md | 27个API完整参考 |
| 04-portal-management.md | 门户管理机制 |
| 05-data-modes.md | model/custom/release 三种模式 |
| 06-release-workflow.md | 发布流程 |
| 07-examples.md | 使用示例 |
| 08-mock-data.md | 模拟数据验证 |
快速开始
from aibridge import JNPFClient
client = JNPFClient(base_url="http://localhost:30000", app_code="myapp")
client.login("admin", password)
# 获取门户列表
portals = client.portal.get_list()
print(portals.data)
# 创建门户
new_portal = client.portal.create({
"fullName": "销售看板",
"enCode": "sales_dashboard",
"type": "model",
"systemId": "your_system_id"
})
# 发布门户
client.portal.release(new_portal.id, {"systemId": "your_system_id"})
组件速查 (21种)
| 类别 | 数量 | 组件 |
|---|---|---|
| 布局控件 | 2 | card(卡片面板), tab(标签面板) |
| 基础控件 | 5 | text(文本), image(图片), carousel(轮播图), video(视频), iframe |
| 系统控件 | 4 | todo(我的待办), todoList(待签/待办/在办), notice(公告通知) |
| 图表控件 | 10 | dataBoard, tableList, barChart, pieChart, lineChart, radarChart, timeAxis, rankList, mapChart, customEcharts |
| 筛选控件 | 1 | filter(筛选器) |
核心概念
三种数据模式
| 模式 | 说明 | 使用场景 |
|---|---|---|
| model | 模板模式 | 门户设计态,未发布的草稿 |
| custom | 自定义模式 | 用户个性化定制(拖拽调整) |
| release | 发布模式 | 正式发布的门户,供最终用户使用 |
发布流程
创建门户(type=model) → 设计组件 → 创建管理配置 → 发布(release) → 设置默认
示例门户 ID
| 名称 | ID | 组件特点 |
|---|---|---|
| 常规门户 | 584307160905678853 | 柱状图、雷达图、排行榜、时间轴、地图、轮播图、我的待办 |
| 门户设计 | 584307823228223493 | 数据面板、表格列表、待办事项、公告通知、图片、排行榜、文本、Iframe、自定义echart |
| 流程门户 | 585481192002814853 | 我的待办、待签事项、在办事项、待办事项 |
| 筛选图表 | 797386216092729925 | 筛选器、表格列表、柱状图(动态数据接口) |
常见问题
- 门户不显示: 检查是否已发布(
release),并确认门户管理配置正确 - 图表无数据: 确认
dataType为dynamic且propsApi指向有效的数据接口ID - 发布失败: 使用
get_system_filter()检查目标系统是否可用