Files
dacli/docs/cmd-review/bigscreen-components.md
T
sswandClaude 9d390dd8e0 docs(bigscreen): v0.14 端点修正 + 完整构造大屏文档 + 36 组件 metadata
## 文档更新
- docs/cmd-review/bigscreen.md: 加 v0.14 章节 (端点修正 30000 jnpf-visualdata, webapi 镜像, construct 命令 22 options, 7 步流程)
- docs/cmd-review/bigscreen-components.md: 新建, 36 组件 metadata (prop/类型/dataType 推荐/option keys/分类列表)
- docs/cmd-review/v0.14-webapi-rollout-plan.md: §2.1 端点修正 (30000 不是 32000), §2.5 webapi/role.ts 是 loadRole (webapi/permission.ts 是 loadOrg)
- docs/cmd-review/v0.13-webapi-form-workflow-refactor.md: §8.1 端点修正 + web 真实 url 来源

## 端到端验证 (testspace, 2026-07-01)
- 5 组件大屏构造 (bar/text/map/video/table, dataType=0): ✓ PASS
- --from-json 路径 (2 组件): ✓ PASS
- --validate-only 路径: ✓ PASS
- TC-C dacli test render --module=bigscreen (4 关卡 list/form/必填/schema): ✓ PASS
- TC-C dacli test render --module=bigscreen --id=X (5 关卡 + 单条 schema): ✓ PASS
- dataType=1 缺 url 校验 (5 项失败阻断): ✓ PASS

## 端点修正
- 错误: /api/visual/* → 32000 jnpf-datareport-univer (报表)
- 正确: /api/visual/* → 30000 jnpf-visualdata (大屏独立微服务)
- web 端 public/config.js 设 window.$website.url = '/api/blade-visual', nginx 代理转发

Co-Authored-By: Claude <[email protected]>
2026-07-01 17:27:48 +08:00

13 KiB

dacli bigscreen 36 组件 metadata (v0.14+, 2026-07-01)

镜像源: jnpf/前端/jnpf-web-datascreen-vue3/src/option/components/*.vue (36 个 .vue 文件, 不含 _ 开头) 构造入口: dacli bigscreen construct --prop=<name> (多次) 完整 metadata 提取: 见 Phase 2 webapi/datascreen.ts:getComponentDefaults() 镜像实现

1. 36 组件总览

# prop 类型 用途 推荐 dataType
1 bar 图表 柱状图 0/1/2
2 line 图表 折线图 0/1/2
3 pie 图表 饼图 0/1/2
4 gauge 图表 仪表盘 0/1
5 radar 图表 雷达图 0/1
6 scatter 图表 散点图 0/1
7 funnel 图表 漏斗图 0/1
8 wordcloud 图表 词云图 0/1
9 pictorialbar 图表 象形柱图 0/1
10 progress 图表 进度条 0/1
11 graph 图表 关系图 (graph) 0/1
12 text 文本 文字标签 0/4
13 map 地图 地图 (含飞线/热力/区域) 0/1
14 video 媒体 视频播放 0 (value=url)
15 audio 媒体 音频播放 0 (value=url)
16 table 表格 数据表格 0/1/2
17 swiper 容器 轮播图 (子组件)
18 tabs 容器 选项卡 (子组件)
19 group 容器 组合/分组 (子组件)
20 common 容器 通用容器 (子组件)
21 iframe 嵌入 内嵌网页 0 (value=url)
22 img 嵌入 单图 0 (value=url)
23 imgborder 装饰 带边框图片 0 (value=url)
24 decoration 装饰 装饰元素 (无数据)
25 borderBox 装饰 边框盒 (无数据)
26 clapper 装饰 翻牌器 (数字翻牌) 0/1
27 flop 装饰 数字翻牌 (另一种实现) 0/1
28 fullscreen 装饰 全屏按钮 (无数据)
29 html 嵌入 HTML 代码 0 (value=html)
30 svg 嵌入 SVG 图 0 (value=svg)
31 rectangle 装饰 矩形装饰 (无数据)
32 time 文本 时间显示 (无数据, 自动当前时间)
33 datetime 文本 日期时间显示 (无数据, 自动当前日期)
34 vue 嵌入 Vue 组件嵌入 (子组件)
35 datav 装饰 DataV 装饰库组件 (无数据)
36 main 主控 主组件 (设计器内嵌, 不直接用) (无数据)

说明: main.vue 是设计器主控组件, 不通过 --prop=main 直接构造 (会被 validProp 跳过). swiper/tabs/group/common/vue/datav 是容器, 需要子组件配置, 单一 --prop 通常只能建壳.

2. dataType 推荐 (镜像 build.vue:666-689)

dataType 名称 镜像源 必填字段 典型组件
0 static (静态) build.vue:667-668 isStatic value (JSON 字符串) 全部
1 api (REST) build.vue:670-671 isApi url 图表/表格
2 sql (数据库) build.vue:672-673 isSql sql 图表/表格
3 ws (websocket) build.vue:674-675 isWs url 实时图表
4 record (recordId) build.vue:676-677 isRecord value (recordId) text/表格
5 public (公共 API) build.vue:678-679 isPublic url 通用
6 mqtt build.vue:680-681 isMqtt url 实时图表
7 node (节点) build.vue:682-683 isNode (无) 内部

校验失败示例 (dacli bigscreen construct 端到端测试 2026-07-01):

✗ 组件 "bar" dataType=1 (api) 缺 url 字段 (build.vue:670-671 isApi)
✗ 组件 "text" dataType=1 (api) 缺 url 字段 (build.vue:670-671 isApi)
... (5 项校验失败)

3. 默认 option 概要 (从 components/*.vue 提取)

3.1 图表组件 (12 个)

bar.vue (name: 'bar')

  • option keys: category (竖展示), barWidth (最大宽度), barRadius (圆角), barMinHeight (最小高度)
  • dataType 推荐: 0 (静态) / 1 (REST API) / 2 (SQL)

line.vue (name: 'line')

  • option keys: smooth (平滑曲线), symbol (标记图形), lineStyle (线条样式), area (区域填充)
  • dataType 推荐: 0 / 1 / 2

pie.vue (name: 'pie')

  • option keys: radius (半径), center (中心), roseType (南丁格尔), label (标签)
  • dataType 推荐: 0 / 1 / 2

gauge.vue (name: 'gauge')

  • option keys: min / max / splitNumber (刻度), axisLine (轴线), pointer (指针), detail (详情)
  • dataType 推荐: 0 / 1

radar.vue (name: 'radar')

  • option keys: shape (形状 polygon/circle), indicator (指示器数组), splitArea (分隔区域)
  • dataType 推荐: 0 / 1

scatter.vue (name: 'scatter')

  • option keys: symbolSize (标记大小), symbol (形状), itemStyle (数据样式)
  • dataType 推荐: 0 / 1

funnel.vue (name: 'funnel')

  • option keys: sort (排序 asc/desc/none), gap (间距), minSize / maxSize, label (标签位置)
  • dataType 推荐: 0 / 1

wordcloud.vue (name: 'wordcloud')

  • option keys: shape (形状 circle/card/diamond/triangle/star), sizeRange (字号范围), rotationRange (旋转)
  • dataType 推荐: 0 / 1

pictorialbar.vue (name: 'pictorialbar')

  • option keys: symbol (图形), symbolSize (大小), symbolOffset (偏移)
  • dataType 推荐: 0 / 1

progress.vue (name: 'progress')

  • option keys: type (line/circle/dashboard), percent (百分比), strokeColor (颜色)
  • dataType 推荐: 0 / 1

graph.vue (name: 'graph')

  • option keys: layout (布局 none/circular/force), categories (分类), force (力导向参数)
  • dataType 推荐: 0 / 1

3.2 文本组件 (3 个)

text.vue (name: 'text')

  • option keys: fontFamily, fontSize, color, split, lineHeight, backgroundColor, fontWeight, textAlign, scroll (跑马灯)
  • dataType 推荐: 0 / 4 (recordId)
  • value 必填 (静态文本内容)

time.vue (name: 'time')

  • option keys: format (YYYY-MM-DD HH:mm:ss), fontSize, color, fontFamily
  • dataType: 无需 (自动当前时间)

datetime.vue (name: 'datetime')

  • option keys: 同 time.vue, 加 dateFormat, timeFormat
  • dataType: 无需

3.3 媒体组件 (2 个)

video.vue (name: 'video')

  • option keys: autoplay, loop, controls, muted, poster, objectFit
  • dataType 推荐: 0 (value=视频 URL, mp4/webm)
  • 校验: video 组件建议显式 value='' 或 url, 否则 warn "未设 value, 预览会显示空"

audio.vue (name: 'audio')

  • option keys: autoplay, loop, controls, volume
  • dataType 推荐: 0 (value=音频 URL, mp3/wav)

3.4 表格 (1 个)

table.vue (name: 'table')

  • option keys: column (列定义: prop/label/width/sort/fixed/align), stripe, border, height, rowHeight
  • dataType 推荐: 0 / 1 / 2
  • value 必填 (JSON 数组, 格式: [{col1:val1, col2:val2}, ...])

3.5 地图 (1 个)

map.vue (name: 'map')

  • option keys: mapType (china/world/province/city), center (中心坐标), zoom, roam, visualMap, seriesType (effectScatter/lines/heatmap)
  • dataType 推荐: 0 / 1 / 2

3.6 容器组件 (5 个)

swiper.vue (name: 'swiper')

  • option keys: autoplay, interval, loop, indicator (指示器), duration
  • 子组件: 通过 children 嵌套 img/text 等
  • 校验: swiper 组件建议显式 value, 否则 warn

tabs.vue (name: 'tabs')

  • option keys: position (top/right/bottom/left), type (card/border-card), tabList
  • 子组件: 每个 tab 下嵌套其他组件

group.vue (name: 'group')

  • option keys: width, height, position, display (flex/block)
  • 子组件: 嵌套任意组件

common.vue (name: 'common')

  • option keys: width, height, position, backgroundColor
  • 子组件: 通用容器

vue.vue (name: 'vue')

  • option keys: 嵌入自定义 Vue 组件路径
  • 子组件: 自定义

3.7 嵌入组件 (3 个)

iframe.vue (name: 'iframe')

  • option keys: src (URL)
  • dataType 推荐: 0 (value=URL)
  • 必填 value

img.vue (name: 'img')

  • option keys: src, objectFit, width, height, onError
  • dataType 推荐: 0 (value=图片 URL)

html.vue (name: 'html')

  • option keys: html (HTML 字符串)
  • dataType 推荐: 0 (value=HTML)

svg.vue (name: 'svg')

  • option keys: svg (SVG 字符串), width, height
  • dataType 推荐: 0 (value=SVG)

3.8 装饰组件 (10 个)

decoration.vue (name: 'decoration')

  • option keys: type (1/2/3/4/5/6/7/8/9/10/11/12 不同装饰样式)
  • dataType: 无需

borderBox.vue (name: 'borderBox')

  • option keys: color, backgroundColor, width, height
  • dataType: 无需

clapper.vue (name: 'clapper')

  • option keys: prefix, suffix, duration, separator, fontSize, color
  • dataType 推荐: 0 / 1

flop.vue (name: 'flop')

  • option keys: number, toFixed, duration, fontSize, color
  • dataType 推荐: 0 / 1

fullscreen.vue (name: 'fullscreen')

  • option keys: width, height, backgroundColor
  • dataType: 无需 (全屏按钮)

rectangle.vue (name: 'rectangle')

  • option keys: width, height, color, borderRadius
  • dataType: 无需

imgborder.vue (name: 'imgborder')

  • option keys: src, borderColor, borderWidth, width, height
  • dataType: 无需

datav.vue (name: 'datav')

  • DataV 装饰库组件 (capsule/circleRunning/jigsaw/digitalFlop/decoration1-12)
  • option keys 随 type 变化
  • dataType: 无需

3.9 主控 (1 个, 不直接构造)

main.vue (name: 'mains' ⚠ 注意带 s 后缀)

  • 设计器主控组件, 不通过 --prop 构造
  • validProp 会跳过 (不在 dataList/titleList 等分类里)

4. 组件分类列表 (镜像 build.vue:1040-1042 validProp)

分类 包含组件
titleList title, group, common (副标题类)
barList bar (柱状图)
lineList line, graph, scatter, pictorialbar
pieList pie, funnel, gauge, radar, wordcloud
textList text, time, datetime
mapList map
tableList table
mediaList video, audio
swiperList swiper
tabsList tabs
embedList iframe, img, html, svg, vue
decorationList decoration, borderBox, clapper, flop, fullscreen, rectangle, imgborder, datav, progress

校验用途: dacli 镜像 validProp(name) 检查 active 组件 prop 是否在以上分类里, 决定属性编辑面板显示哪些分组. 但 dacli bigscreen construct 暂时只校验 prop 是否在 listComponentProps() (36 个), 不细分分类.

5. 完整构造示例 (testspace 端到端验证, 2026-07-01)

# 5 组件 demo (bar+text+map+video+table, 静态数据 dataType=0)
TS=$(date +%s)
dacli bigscreen construct --template=base \
  --fullName="TC-5comp-$TS" --enCode="tc-5comp-$TS" --category=1 \
  --prop=bar --prop=text --prop=map --prop=video --prop=table \
  --dataType=0 --value='[]' \
  --json
# ✓ 校验通过 (36 有效 prop, 5 组件)
# ✓ addObj 创建空大屏成功 id=842054170268666117
# ✓ updateObj save 完整 formdata 成功 (5 组件已写入)
# ✓ 大屏已发布 (status=1)
# {"id":"842054170268666117","enCode":"tc-5comp-...","fullName":"TC-5comp-...","componentCount":5}

# 校验 only (不发 API)
dacli bigscreen construct --template=base --fullName=val-only --enCode=val-only --category=1 --validate-only --json
# {"validated":true,"baseConfig":{...},"nav":[...]}

# from-json (用户设计)
cat > /tmp/design.json <<EOF
{
  "baseConfig": {"width": 1920, "height": 1080, "theme": 1, "screen": false},
  "nav": [
    {"prop": "bar", "x": 100, "y": 100, "w": 400, "h": 300, "data": {"dataType": 0, "value": "bar data"}},
    {"prop": "text", "x": 600, "y": 100, "w": 400, "h": 200, "data": {"dataType": 0, "value": "hello"}}
  ]
}
EOF
dacli bigscreen construct --from-json=/tmp/design.json --fullName=TC-json --enCode=tc-json --category=1 --json
# {"id":"842054339479472389","componentCount":2}

6. 镜像实现位置

  • webapi/datascreen.ts:getBaseConfig() — 镜像 option/config.js:35-72 (theme/color/table/dic/componentList)
  • webapi/datascreen.ts:getComponentDefaults(prop) — 镜像 option/components/<prop>.vue default data (技术点: vue compiler, dacli 读 <script> default export)
  • webapi/datascreen.ts:listComponentProps() — 36 个 prop 列表, 用于 validProp 校验
  • webapi/datascreen.ts:constructComponentJson(navInput) — 镜像 build.vue:705-709 nav 结构
  • webapi/datascreen.ts:constructConfigDetail(baseConfig, nav) — 镜像 header.vue:200-211 save formdata
  • commands/bigscreen/_validate.ts:validateConstruct() — 镜像 build.vue:666-692 (dataType) + 1040-1042 (validProp) + mixins/index.js:35 (configData)

7. 已知限制

  • 完整 option 注入: 当前 --prop 多次时, 所有组件用同一组 option (默认), 不读 <prop>.vue 的 default. Phase 7+ 改进: --prop=bar --option=barWidth:50,barRadius:5
  • 容器组件 children: swiper/tabs/group/common 容器组件的子组件需要嵌套 nav[].children, 当前 --prop=swiper 单次只能建壳
  • main.vue 带 s 后缀: name: 'mains', 但 validProp 不直接校验 name, 走 listComponentProps 检查 36 prop, 所以不影响 --prop
  • datav 组件多 type: datav.vue 有 capsule/circleRunning/jigsaw/digitalFlop/decoration1-12 等多个 type, 需要 type 参数, 当前未支持