Jelajahi Sumber

更新平面图接口定义

yunxing 4 tahun lalu
induk
melakukan
2549a3269b
1 mengubah file dengan 43 tambahan dan 82 penghapusan
  1. 43 82
      docs/guides/format/planJson.md

+ 43 - 82
docs/guides/format/planJson.md

@@ -6,18 +6,17 @@
 
 ## 整体数据格式
 
-``` json5
+``` json
 {
-    data:[
+    data: [
         {
-            available: false                    // 
             elements:{                          // 平面图展示所需数据
-                nodes:[],                       // 图例节点,所有与对象实例相关的图例(图标类型与区域)
-                markers:[],                     // 与对象实例的标识对象(增加文本注释,图上的图片说明)
-                relations:[],                   // 管线对象
+                objExtInfo: [],                 // 对象扩展信息,所有与对象实例相关的图例(图标类型与区域)
+                markers: [],                    // 与对象实例的标识对象(增加文本注释,图上的图片说明)
+                relations: [],                  // 管线对象
             },
             id: '',                             // 图编号
-            graphId:'',                         // 图 id
+            graphId: '',                        // 图 id
             name: '',                           // 名称
             folderId: '',                       // 文件夹 id
             projectId: '',                      // 项目 id
@@ -29,51 +28,52 @@
             version: '',                        // 版本信息
             createTime: '',                     // 创建时间
             lastUpdate: '',                     // 最后更新时间
-            state: 0,                           // 标记(1草稿箱,2待审核,3审核完成,4回收站 ,0发布)
-            mapShow: true,                      // 底图显隐
-            rule: {                             // 实例数据获取规则
-                equip: [],                      // 设备规则列表
-                equipGroup: [],                 // 设备组规则列表
-                room: [],                       // 空间规则列表
-            },
+            state: 'Draft',                     // 标记(Draft: 未发布,WaitCheck: 待审核,Checked: 审核完成,Recyle: 回收站 ,Publish: 发布)
+            mapShow: true,                      // 底图显隐,   //TODO: 业务场景
+            ruleList: [                         // 实例数据获取规则
+                {
+                    returnType: '',             // 返回类型(设备: equip, 设备组: equipGroup, 空间: zone)
+                    commond: '',                // 查询:query, 删除:delete
+                    params: {},                 // 查询参数
+                    note: '',                   // 命令说明
+                }
+            ],
+            hideList: [''],                     // 隐藏的实例ID( 设备,空间 在物理世界的ID)
+            style: [],                          // 风格    TODO: 原始样式,图例库样式,模板,具体某个图
         }
     ],
-    message: '',
-    result: ''
+    message: '',                                //  接口返回提示
+    result: ''                                  // 接口返回类型(success: 成功, error: 失败)
 }
 ```
 
-## 图例节点
+## 对象扩展信息
 
-``` json5
-    nodes:[
+``` json
+    objExtInfo:[
         {   
             id: '',                             // 图编号
             graphId: '',                        // 图 id
             nodeId: '',                         // node 节点本身 id
             name: '',                           // 名称
-            attachObjectIds:[],                 // 返回物理世界对象 id 列表
-            graphElementId: '',                 // 对应的图元 id
+            attachObjectIds: [],                 // 返回物理世界对象 id 列表
             type: '',                           // 节点类型(image / zone)
             pos: {x: 0, y: 0},                  // 位置
-            scale: {x: 1, y: 1, Z: 1},          // 缩放
-            rotate: {x: 0, y: 0, Z: 0},         // 旋转
-            size: {width:0, height: 0},         // 大小
-            anchorList:[
-                    {
-                        id: '',                 // 锚点 id
-                        pos: {x: 0, y: 0},      // 锚点的坐标
-                    },
-                    ...
-                ],
-            outline: [
-                [{x:0,y:0,z:0},...],            // 外轮廓 
-                ...                             // 内轮廓
-            ],                                  // 轮廓线
             properties: {},                     // 由应用自己定义
-            style: {                            // 绘图样式
-                default: {}                     // 默认状态样式
-            }
+        },
+        ...
+    ]
+```
+
+
+## 风格定义
+
+> 可以指定引用文件(只能引用一个), 或者使用自己的风格
+
+``` json
+    style: [
+        {
+
         },
         ...
     ]
@@ -81,8 +81,8 @@
 
 ## 标识对象
 
-``` json5
-    markers:[
+``` json
+    markers: [
         {
             id: '',                             // 图编号
             graphId: '',                        // 图 id
@@ -104,7 +104,9 @@
 
 ## 对象关系
 
-``` json5
+> 设备删除/新增, 需要手动处理管线
+
+``` json
     relations: [
         {
             id: '',                             // 图编号
@@ -127,44 +129,3 @@
         ...
     ]
 ```
-
-## 设备规则
-
-``` json5
-    equip: [
-        {
-            equipTypeIds: [''],                 // 设备类型列表
-            roomTypeIds: [''],                  // 分区类型列表
-            roomFuncType: [''],                 // 空间功能区类型列表
-            roomIds: [''],                      // 空间实例ID列表
-        },
-        ...
-    ]
-```
-
-## 设备组规则
-
-``` json5
-    equipGroup: [
-        {
-            equipTypeIds: [''],                 // 设备类型列表
-            roomTypeIds: [''],                  // 分区类型列表
-            roomFuncType: [''],                 // 空间功能区类型列表
-            roomIds: [''],                      // 空间实例ID列表
-        },
-        ...
-    ]
-```
-
-## 空间规则
-
-``` json5
-    room: [
-        {
-            roomTypeIds: [''],                  // 分区类型列表
-            roomFuncType: [''],                 // 空间功能区类型列表
-            roomIds: [''],                      // 空间实例ID列表
-        },
-        ...
-    ]
-```