更新文档

This commit is contained in:
wanglin2 2023-04-05 16:40:29 +08:00
parent 52d094a7c7
commit 5675e29df3
9 changed files with 91 additions and 1 deletions

View File

@ -1,6 +1,6 @@
{ {
"name": "simple-mind-map", "name": "simple-mind-map",
"version": "0.5.0", "version": "0.5.1",
"description": "一个简单的web在线思维导图", "description": "一个简单的web在线思维导图",
"authors": [ "authors": [
{ {

View File

@ -1,5 +1,11 @@
# Changelog # Changelog
## 0.5.1
optimization: 1.Only respond to shortcut key events when the mouse is inside the canvas
Fix: 1.Fix the issue of incorrect node position during fast operation
## 0.5.0 ## 0.5.0
This version is mainly about code level changes and optimization, with the core goal of improving rendering performance and reducing stuck issues. This version is mainly about code level changes and optimization, with the core goal of improving rendering performance and reducing stuck issues.

View File

@ -1,6 +1,9 @@
<template> <template>
<div> <div>
<h1>Changelog</h1> <h1>Changelog</h1>
<h2>0.5.1</h2>
<p>optimization: 1.Only respond to shortcut key events when the mouse is inside the canvas</p>
<p>Fix: 1.Fix the issue of incorrect node position during fast operation</p>
<h2>0.5.0</h2> <h2>0.5.0</h2>
<p>This version is mainly about code level changes and optimization, with the core goal of improving rendering performance and reducing stuck issues.</p> <p>This version is mainly about code level changes and optimization, with the core goal of improving rendering performance and reducing stuck issues.</p>
<p>New: 1.Support custom expansion and collapse node icons and colors;</p> <p>New: 1.Support custom expansion and collapse node icons and colors;</p>

View File

@ -48,6 +48,9 @@ const mindMap = new MindMap({
| defaultInsertBelowSecondLevelNodeTextv0.4.7+ | String | 分支主题 | Text for nodes below the second level inserted by default | | | defaultInsertBelowSecondLevelNodeTextv0.4.7+ | String | 分支主题 | Text for nodes below the second level inserted by default | |
| expandBtnStylev0.5.0+ | Object | { color: '#808080', fill: '#fff' } | Expand the color of the stow button | | | expandBtnStylev0.5.0+ | Object | { color: '#808080', fill: '#fff' } | Expand the color of the stow button | |
| expandBtnIconv0.5.0+ | Object | { open: '', close: '' } | Customize the icon of the expand/collapse button, and you can transfer the svg string of the icon | | | expandBtnIconv0.5.0+ | Object | { open: '', close: '' } | Customize the icon of the expand/collapse button, and you can transfer the svg string of the icon | |
| enableShortcutOnlyWhenMouseInSvgv0.5.1+ | Boolean | true | Only respond to shortcut key events when the mouse is inside the canvas | |
| enableNodeTransitionMovev0.5.1+ | Boolean | true | Whether to enable node animation transition | |
| nodeTransitionMoveDurationv0.5.1+ | Number | 300 | If node animation transition is enabled, the transition time can be set using this attribute, in milliseconds | |
### Watermark config ### Watermark config
@ -200,6 +203,8 @@ Listen to an event. Event list:
| node_draggingv0.4.5+ | Triggered when a node is dragged | node(The currently dragged node) | | node_draggingv0.4.5+ | Triggered when a node is dragged | node(The currently dragged node) |
| node_dragendv0.4.5+ | Triggered when the node is dragged and ends | | | node_dragendv0.4.5+ | Triggered when the node is dragged and ends | |
| associative_line_clickv0.4.5+ | Triggered when an associated line is clicked | path(Connector node)、clickPath(Invisible click line node)、node(Start node)、toNode(Target node) | | associative_line_clickv0.4.5+ | Triggered when an associated line is clicked | path(Connector node)、clickPath(Invisible click line node)、node(Start node)、toNode(Target node) |
| svg_mouseenterv0.5.1+ | Triggered when the mouse moves into the SVG canvas | eevent object |
| svg_mouseleavev0.5.1+ | Triggered when the mouse moves out of the SVG canvas | eevent object |
### emit(event, ...args) ### emit(event, ...args)

View File

@ -196,6 +196,27 @@
<td>Customize the icon of the expand/collapse button, and you can transfer the svg string of the icon</td> <td>Customize the icon of the expand/collapse button, and you can transfer the svg string of the icon</td>
<td></td> <td></td>
</tr> </tr>
<tr>
<td>enableShortcutOnlyWhenMouseInSvgv0.5.1+</td>
<td>Boolean</td>
<td>true</td>
<td>Only respond to shortcut key events when the mouse is inside the canvas</td>
<td></td>
</tr>
<tr>
<td>enableNodeTransitionMovev0.5.1+</td>
<td>Boolean</td>
<td>true</td>
<td>Whether to enable node animation transition</td>
<td></td>
</tr>
<tr>
<td>nodeTransitionMoveDurationv0.5.1+</td>
<td>Number</td>
<td>300</td>
<td>If node animation transition is enabled, the transition time can be set using this attribute, in milliseconds</td>
<td></td>
</tr>
</tbody> </tbody>
</table> </table>
<h3>Watermark config</h3> <h3>Watermark config</h3>
@ -490,6 +511,16 @@ poor performance and should be used sparingly.</p>
<td>Triggered when an associated line is clicked</td> <td>Triggered when an associated line is clicked</td>
<td>path(Connector node)clickPath(Invisible click line node)node(Start node)toNode(Target node)</td> <td>path(Connector node)clickPath(Invisible click line node)node(Start node)toNode(Target node)</td>
</tr> </tr>
<tr>
<td>svg_mouseenterv0.5.1+</td>
<td>Triggered when the mouse moves into the SVG canvas</td>
<td>eevent object</td>
</tr>
<tr>
<td>svg_mouseleavev0.5.1+</td>
<td>Triggered when the mouse moves out of the SVG canvas</td>
<td>eevent object</td>
</tr>
</tbody> </tbody>
</table> </table>
<h3>emit(event, ...args)</h3> <h3>emit(event, ...args)</h3>

View File

@ -1,5 +1,11 @@
# Changelog # Changelog
## 0.5.1
优化1.只有当鼠标在画布内才响应快捷键事件
修复1.修复快速操作时节点位置不正确的问题
## 0.5.0 ## 0.5.0
这个版本主要是代码层面的改动和优化,核心是为了提升渲染性能,减少卡顿问题。 这个版本主要是代码层面的改动和优化,核心是为了提升渲染性能,减少卡顿问题。

View File

@ -1,6 +1,9 @@
<template> <template>
<div> <div>
<h1>Changelog</h1> <h1>Changelog</h1>
<h2>0.5.1</h2>
<p>优化1.只有当鼠标在画布内才响应快捷键事件</p>
<p>修复1.修复快速操作时节点位置不正确的问题</p>
<h2>0.5.0</h2> <h2>0.5.0</h2>
<p>这个版本主要是代码层面的改动和优化核心是为了提升渲染性能减少卡顿问题</p> <p>这个版本主要是代码层面的改动和优化核心是为了提升渲染性能减少卡顿问题</p>
<p>新增1.支持自定义展开收起节点图标和颜色</p> <p>新增1.支持自定义展开收起节点图标和颜色</p>

View File

@ -48,6 +48,9 @@ const mindMap = new MindMap({
| defaultInsertBelowSecondLevelNodeTextv0.4.7+ | String | 分支主题 | 默认插入的二级以下节点的文字 | | | defaultInsertBelowSecondLevelNodeTextv0.4.7+ | String | 分支主题 | 默认插入的二级以下节点的文字 | |
| expandBtnStylev0.5.0+ | Object | { color: '#808080', fill: '#fff' } | 展开收起按钮的颜色 | | | expandBtnStylev0.5.0+ | Object | { color: '#808080', fill: '#fff' } | 展开收起按钮的颜色 | |
| expandBtnIconv0.5.0+ | Object | { open: '', close: '' } | 自定义展开收起按钮的图标可以传图标的svg字符串 | | | expandBtnIconv0.5.0+ | Object | { open: '', close: '' } | 自定义展开收起按钮的图标可以传图标的svg字符串 | |
| enableShortcutOnlyWhenMouseInSvgv0.5.1+ | Boolean | true | 是否只有当鼠标在画布内才响应快捷键事件 | |
| enableNodeTransitionMovev0.5.1+ | Boolean | true | 是否开启节点动画过渡 | |
| nodeTransitionMoveDurationv0.5.1+ | Number | 300 | 如果开启节点动画过渡可以通过该属性设置过渡的时间单位ms | |
### 水印配置 ### 水印配置
@ -197,6 +200,8 @@ mindMap.setTheme('主题名称')
| node_draggingv0.4.5+ | 当某个节点被拖拽时触发 | node当前被拖拽的节点 | | node_draggingv0.4.5+ | 当某个节点被拖拽时触发 | node当前被拖拽的节点 |
| node_dragendv0.4.5+ | 节点被拖拽结束时触发 | | | node_dragendv0.4.5+ | 节点被拖拽结束时触发 | |
| associative_line_clickv0.4.5+ | 点击某条关联线时触发 | path连接线节点、clickPath不可见的点击线节点、node起始节点、toNode目标节点 | | associative_line_clickv0.4.5+ | 点击某条关联线时触发 | path连接线节点、clickPath不可见的点击线节点、node起始节点、toNode目标节点 |
| svg_mouseenterv0.5.1+ | 鼠标移入svg画布时触发 | e事件对象 |
| svg_mouseleavev0.5.1+ | 鼠标移出svg画布时触发 | e事件对象 |
### emit(event, ...args) ### emit(event, ...args)

View File

@ -196,6 +196,27 @@
<td>自定义展开收起按钮的图标可以传图标的svg字符串</td> <td>自定义展开收起按钮的图标可以传图标的svg字符串</td>
<td></td> <td></td>
</tr> </tr>
<tr>
<td>enableShortcutOnlyWhenMouseInSvgv0.5.1+</td>
<td>Boolean</td>
<td>true</td>
<td>是否只有当鼠标在画布内才响应快捷键事件</td>
<td></td>
</tr>
<tr>
<td>enableNodeTransitionMovev0.5.1+</td>
<td>Boolean</td>
<td>true</td>
<td>是否开启节点动画过渡</td>
<td></td>
</tr>
<tr>
<td>nodeTransitionMoveDurationv0.5.1+</td>
<td>Number</td>
<td>300</td>
<td>如果开启节点动画过渡可以通过该属性设置过渡的时间单位ms</td>
<td></td>
</tr>
</tbody> </tbody>
</table> </table>
<h3>水印配置</h3> <h3>水印配置</h3>
@ -483,6 +504,16 @@ mindMap.setTheme(<span class="hljs-string">&#x27;主题名称&#x27;</span>)
<td>点击某条关联线时触发</td> <td>点击某条关联线时触发</td>
<td>path连接线节点clickPath不可见的点击线节点node起始节点toNode目标节点</td> <td>path连接线节点clickPath不可见的点击线节点node起始节点toNode目标节点</td>
</tr> </tr>
<tr>
<td>svg_mouseenterv0.5.1+</td>
<td>鼠标移入svg画布时触发</td>
<td>e事件对象</td>
</tr>
<tr>
<td>svg_mouseleavev0.5.1+</td>
<td>鼠标移出svg画布时触发</td>
<td>e事件对象</td>
</tr>
</tbody> </tbody>
</table> </table>
<h3>emit(event, ...args)</h3> <h3>emit(event, ...args)</h3>