Doc: update

This commit is contained in:
街角小林 2024-06-27 09:26:04 +08:00
parent f80317a449
commit 80f45e5e7d
4 changed files with 40 additions and 4 deletions

View File

@ -5,8 +5,20 @@ includes many built-in commands and can also be added manually. A command refers
to an operation that needs to add a copy to the history stack data. The
`mindMap.command` instance can be obtained through this."
## Props
### history
The current list of all historical data. Do not manually modify the array.
### activeHistoryIndex
The current historical data index. Do not manually modify this property.
## Methods
Please use the command 'Back' or 'FORWARD' to move forward or backward.
### pause()
> v0.9.11+
@ -38,7 +50,7 @@ removed
### getCopyData()
Get a copy of the rendering tree data
Get a copy of the rendering tree data. That is, the data of the current canvas.
### clearHistory()

View File

@ -5,7 +5,13 @@
includes many built-in commands and can also be added manually. A command refers
to an operation that needs to add a copy to the history stack data. The
<code>mindMap.command</code> instance can be obtained through this.&quot;</p>
<h2>Props</h2>
<h3>history</h3>
<p>The current list of all historical data. Do not manually modify the array.</p>
<h3>activeHistoryIndex</h3>
<p>The current historical data index. Do not manually modify this property.</p>
<h2>Methods</h2>
<p>Please use the command 'Back' or 'FORWARD' to move forward or backward.</p>
<h3>pause()</h3>
<blockquote>
<p>v0.9.11+</p>
@ -26,7 +32,7 @@ to an operation that needs to add a copy to the history stack data. The
<p><code>fn</code>: Method to be removed, if not provided all methods for the command will be
removed</p>
<h3>getCopyData()</h3>
<p>Get a copy of the rendering tree data</p>
<p>Get a copy of the rendering tree data. That is, the data of the current canvas.</p>
<h3>clearHistory()</h3>
<p>Clear the history stack data</p>

View File

@ -2,8 +2,20 @@
`command`实例负责命令的添加及执行,内置了很多命令,也可以自行添加,命令指需要在历史堆栈数据里添加副本的操作。可通过`mindMap.command`获取到该实例
## 属性
### history
当前所有的历史数据列表。不要手动修改该数组。
### activeHistoryIndex
当前所在的历史数据索引。不要手动修改该属性。
## 方法
前进后退请使用命令`BACK`或`FORWARD`。
### pause()
> v0.9.11+
@ -34,7 +46,7 @@
### getCopyData()
获取渲染树数据副本
获取渲染树数据副本。即当前画布的数据。
### clearHistory()

View File

@ -2,7 +2,13 @@
<div>
<h1>Command 实例</h1>
<p><code>command</code>实例负责命令的添加及执行内置了很多命令也可以自行添加命令指需要在历史堆栈数据里添加副本的操作可通过<code>mindMap.command</code>获取到该实例</p>
<h2>属性</h2>
<h3>history</h3>
<p>当前所有的历史数据列表不要手动修改该数组</p>
<h3>activeHistoryIndex</h3>
<p>当前所在的历史数据索引不要手动修改该属性</p>
<h2>方法</h2>
<p>前进后退请使用命令<code>BACK</code><code>FORWARD</code></p>
<h3>pause()</h3>
<blockquote>
<p>v0.9.11+</p>
@ -22,7 +28,7 @@
<p><code>name</code>要移除的命令名称</p>
<p><code>fn</code>要移除的方法不传的话移除该命令所有的方法</p>
<h3>getCopyData()</h3>
<p>获取渲染树数据副本</p>
<p>获取渲染树数据副本即当前画布的数据</p>
<h3>clearHistory()</h3>
<p>清空历史堆栈数据</p>