From 42c934cb6dddf21d5d72fb656fe58184391f35a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A1=97=E8=A7=92=E5=B0=8F=E6=9E=97?= <1013335014@qq.com> Date: Tue, 2 Apr 2024 13:57:57 +0800 Subject: [PATCH] Doc: update --- web/src/pages/Doc/zh/course1/index.md | 57 ++++++++++++++------------ web/src/pages/Doc/zh/course1/index.vue | 57 ++++++++++++++------------ web/src/pages/Doc/zh/course7/index.md | 4 ++ web/src/pages/Doc/zh/course7/index.vue | 6 +++ 4 files changed, 72 insertions(+), 52 deletions(-) diff --git a/web/src/pages/Doc/zh/course1/index.md b/web/src/pages/Doc/zh/course1/index.md index 5595cdfe..af3f2212 100644 --- a/web/src/pages/Doc/zh/course1/index.md +++ b/web/src/pages/Doc/zh/course1/index.md @@ -25,33 +25,38 @@ ```js { - data: { - // 节点文本 - text: '根节点', - // 图片 - image: 'xxx.jpg', - imageTitle: '图片名称', - imageSize: { - width: 1152, - height: 1152 - }, - // 图标 - icon: ['priority_1'], - // 标签 - tag: ['标签1', '标签2'], - // 链接 - hyperlink: 'http://lxqnsys.com/', - hyperlinkTitle: '理想青年实验室', - // 备注内容 - note: '理想青年实验室\n一个有意思的角落', - // 概要 - generalization: { - text: '概要的内容' - }, - // 节点是否展开 - expand: true, + data: { + text: '', // 节点的文本,可以是富文本,也就是html格式的,此时richText要设为true + richText: false, // 节点的文本是否是富文本模式 + expand: true, // 节点是否展开 + uid: '',// 节点唯一的id,可不传,内部会生成 + icon: [], // 图标,格式可参考教程里的【插入和扩展节点图标】章节 + image: '', // 图片的url + imageTitle: '', // 图片的标题,可为空 + imageSize: { // 图片的尺寸 + width: 100, // 图片的宽度,必传 + height: 100, // 图片的高度,必传 + custom: false // 如果设为true,图片的显示大小不受主题控制,以imageSize.width和imageSize.height为准 }, - children: []// 子节点 + hyperlink: '', // 超链接地址 + hyperlinkTitle: '', // 超链接的标题 + note: '', // 备注的内容 + attachmentUrl: '',// v0.9.10+,附件url + attachmentName: '',// v0.9.10+,附件名称 + tag: [], // 标签列表 + generalization: {// 节点的概要,如果没有概要generalization设为null即可 + text: ''// 概要的文本 + }, + associativeLineTargets: [''],// 如果存在关联线,那么为目标节点的uid列表 + associativeLineText: '',// 关联线文本 + // ...其他样式字段,可以参考主题 + }, + children [// 子节点,结构和根节点一致 + { + data: {}, + children: [] + } + ] } ``` diff --git a/web/src/pages/Doc/zh/course1/index.vue b/web/src/pages/Doc/zh/course1/index.vue index a2c288cf..ffe0700d 100644 --- a/web/src/pages/Doc/zh/course1/index.vue +++ b/web/src/pages/Doc/zh/course1/index.vue @@ -17,33 +17,38 @@

这是为了避免节点内的文字因为默认样式而出现偏移。

一个节点的基本数据结构如下所示:

{
-    data: {
-        // 节点文本
-        text: '根节点',
-        // 图片
-        image: 'xxx.jpg',
-        imageTitle: '图片名称',
-        imageSize: {
-            width: 1152,
-            height: 1152
-        },
-        // 图标
-        icon: ['priority_1'],
-        // 标签
-        tag: ['标签1', '标签2'],
-        // 链接
-        hyperlink: 'http://lxqnsys.com/',
-        hyperlinkTitle: '理想青年实验室',
-        // 备注内容
-        note: '理想青年实验室\n一个有意思的角落',
-        // 概要
-        generalization: {
-            text: '概要的内容'
-        },
-        // 节点是否展开
-        expand: true,
+  data: {
+    text: '', // 节点的文本,可以是富文本,也就是html格式的,此时richText要设为true
+    richText: false, // 节点的文本是否是富文本模式
+    expand: true, // 节点是否展开
+    uid: '',// 节点唯一的id,可不传,内部会生成
+    icon: [], // 图标,格式可参考教程里的【插入和扩展节点图标】章节
+    image: '', // 图片的url
+    imageTitle: '', // 图片的标题,可为空
+    imageSize: { // 图片的尺寸
+      width: 100, // 图片的宽度,必传
+      height: 100, // 图片的高度,必传
+      custom: false // 如果设为true,图片的显示大小不受主题控制,以imageSize.width和imageSize.height为准
     },
-    children: []// 子节点
+    hyperlink: '', // 超链接地址
+    hyperlinkTitle: '', // 超链接的标题
+    note: '', // 备注的内容
+    attachmentUrl: '',// v0.9.10+,附件url
+    attachmentName: '',// v0.9.10+,附件名称
+    tag: [], // 标签列表
+    generalization: {// 节点的概要,如果没有概要generalization设为null即可
+      text: ''// 概要的文本
+    },
+    associativeLineTargets: [''],// 如果存在关联线,那么为目标节点的uid列表
+    associativeLineText: '',// 关联线文本
+    // ...其他样式字段,可以参考主题
+  },
+  children [// 子节点,结构和根节点一致
+    {
+      data: {},
+      children: []
+    }
+  ]
 }
 

icon可以使用内置的图标,完整图标可以在icons.js文件中查看。也可以扩展图标,参考扩展图标

diff --git a/web/src/pages/Doc/zh/course7/index.md b/web/src/pages/Doc/zh/course7/index.md index bf71c12e..8b3d2a72 100644 --- a/web/src/pages/Doc/zh/course7/index.md +++ b/web/src/pages/Doc/zh/course7/index.md @@ -2,6 +2,10 @@ > 节点自由拖拽的连线可能不会符合你的预期,这个问题基本上不会改,所以自由拖拽功能不建议使用。 +> 另外不要把节点拖拽和自由拖拽搞混,节点拖拽指拖动节点到其他节点上成为其子节点或兄弟节点,自由拖拽只是可以把节点放置在你拖动到的画布位置,并不能改变节点的层级。 + +> 最后要注意这两个功能都需要先注册Drag插件。 + 节点支持自由拖拽,也就是可以把它拖动到你指定的位置,默认是不开启的,如果需要开启可以在实例化`simple-mind-map`时传入开启的选项: ```js diff --git a/web/src/pages/Doc/zh/course7/index.vue b/web/src/pages/Doc/zh/course7/index.vue index 93536d36..08bbaa65 100644 --- a/web/src/pages/Doc/zh/course7/index.vue +++ b/web/src/pages/Doc/zh/course7/index.vue @@ -4,6 +4,12 @@

节点自由拖拽的连线可能不会符合你的预期,这个问题基本上不会改,所以自由拖拽功能不建议使用。

+
+

另外不要把节点拖拽和自由拖拽搞混,节点拖拽指拖动节点到其他节点上成为其子节点或兄弟节点,自由拖拽只是可以把节点放置在你拖动到的画布位置,并不能改变节点的层级。

+
+
+

最后要注意这两个功能都需要先注册Drag插件。

+

节点支持自由拖拽,也就是可以把它拖动到你指定的位置,默认是不开启的,如果需要开启可以在实例化simple-mind-map时传入开启的选项:

new MindMap({
     // ...