Command

⬅ ️返回主页

命令（Command）和 API 的差别

命令和 API 的差别在于，大多数情况下，命令是要产生数据结果和操作历史的，API 只改变脑图的运行时状态。

命令可以执行、查询状态以及当前值。使用到的 API 分别是：

• execCommand(command, args...) 执行指定的命令，有些命令可以带参数
• queryCommandStatue(command) 查询当前命令的状态，状态分为三种：可执行（0）、不可执行（-1）、已执行（1）。
• queryCommandValue(command) 查询当前命令的产生值，不同命令会有不同的结果。

命令快捷键

某些命令会有默认的快捷键，当脑图具有焦点的时候，默认快捷键会生效。比如 Tab 是命令 AppendChildNode 的快捷键。关于快捷键的使用可以参考 shortcut 章节。

命令列表

速查

命令	说明
AppendChildNode	添加子节点到选中的节点中
AppendSiblingNode	添加选中的节点的兄弟节点
Arrange	调整选中节点的位置
ArrangeDown	向下调整选中节点的位置
ArrangeUp	向上调整选中节点的位置
Background	设置选中节点的背景颜色
Bold	加粗选中的节点
Camera	设置当前视野的中心位置到某个节点上
ClearStyle	移除选中节点的样式，包括字体、字号、粗体、斜体、背景色、字体色
Copy	复制当前选中的节点
CopyStyle	拷贝选中节点的当前样式，包括字体、字号、粗体、斜体、背景色、字体色
Cut	剪切当前选中的节点
EditNode	编辑选中的节点
Expand	展开当前选中的节点，保证其可见
ExpandToLevel	展开脑图到指定的层级
FontFamily	设置选中节点的字体
FontSize	设置选中节点的字体大小
ForeColor	设置选中节点的字体颜色
Hand	切换抓手状态，抓手状态下，鼠标拖动将拖动视野，而不是创建选区
HyperLink	为选中的节点添加超链接
Image	为选中的节点添加图片
Italic	加斜选中的节点
Layout	设置选中节点的布局 允许使用的布局可以使用 kityminder.Minder.getLayoutList() 查询
Move	指定方向移动当前视野
Note	设置节点的备注信息
Paste	粘贴已复制的节点到每一个当前选中的节点上
PasteStyle	粘贴已拷贝的样式到选中的节点上，包括字体、字号、粗体、斜体、背景色、字体色
Priority	设置节点的优先级信息
Progress	设置节点的进度信息（添加一个进度小图标）
Redo	重做下一步已回退的操作
RemoveNode	移除选中的节点
ResetLayout	重设选中节点的布局，如果当前没有选中的节点，重设整个脑图的布局
Resource	设置节点的资源标签
Template	设置当前脑图的模板
Theme	设置当前脑图的主题
Undo	回退上一步操作
Zoom	缩放当前的视野到一定的比例（百分比）
ZoomIn	放大当前的视野到下一个比例等级（百分比）
ZoomOut	缩小当前的视野到上一个比例等级（百分比）

AppendChildNode

⬅ 返回目录

添加子节点到选中的节点中

minder.execCommand('AppendChildNode', textOrData);

参数说明

参数	类型	说明
textOrData	`string	object`

状态说明

var state = minder.queryCommandState('AppendChildNode');

state	说明
0	当前有选中的节点
-1	当前没有选中的节点

AppendSiblingNode

⬅ 返回目录

添加选中的节点的兄弟节点

minder.execCommand('AppendSiblingNode', textOrData);

参数说明

参数	类型	说明
textOrData	`string	object`

状态说明

var state = minder.queryCommandState('AppendSiblingNode');

state	说明
0	当前有选中的节点
-1	当前没有选中的节点

Arrange

⬅ 返回目录

调整选中节点的位置

minder.execCommand('Arrange', index);

参数说明

参数	类型	说明
index	number	调整后节点的新位置

状态说明

var state = minder.queryCommandState('Arrange');

state	说明
0	当前选中了具有相同父亲的节点
-1	其它情况

ArrangeDown

⬅ 返回目录

向下调整选中节点的位置

快捷键：Alt + Down

minder.execCommand('ArrangeDown');

状态说明

var state = minder.queryCommandState('ArrangeDown');

state	说明
0	当前选中了具有相同父亲的节点
-1	其它情况

ArrangeUp

⬅ 返回目录

向上调整选中节点的位置

快捷键：Alt + Up

minder.execCommand('ArrangeUp');

状态说明

var state = minder.queryCommandState('ArrangeUp');

state	说明
0	当前选中了具有相同父亲的节点
-1	其它情况

Background

⬅ 返回目录

设置选中节点的背景颜色

minder.execCommand('Background', color);

参数说明

参数	类型	说明
color	string	表示颜色的字符串

状态说明

var state = minder.queryCommandState('Background');

state	说明
0	当前有选中的节点
-1	当前没有选中的节点

返回值

var value = minder.queryCommandValue('Background');

如果只有一个节点选中，返回已选中节点的背景颜色；否则返回 'mixed'。

Bold

⬅ 返回目录

加粗选中的节点

快捷键：Ctrl + B

minder.execCommand('Bold');

状态说明

var state = minder.queryCommandState('Bold');

state	说明
0	当前有选中的节点
-1	当前没有选中的节点
1	当前已选中的节点已加粗

Camera

⬅ 返回目录

设置当前视野的中心位置到某个节点上

minder.execCommand('Camera', focusNode, duration);

参数说明

参数	类型	说明
focusNode	kityminder.MinderNode	要定位的节点
duration	number	设置视野移动的动画时长（单位 ms），设置为 0 不使用动画

状态说明

var state = minder.queryCommandState('Camera');

state	说明
0	始终可用

ClearStyle

⬅ 返回目录

移除选中节点的样式，包括字体、字号、粗体、斜体、背景色、字体色

minder.execCommand('ClearStyle');

状态说明

var state = minder.queryCommandState('ClearStyle');

state	说明
0	当前有选中的节点，并且至少有一个设置了至少一种样式
-1	其它情况

Copy

⬅ 返回目录

复制当前选中的节点

快捷键：Ctrl + C

minder.execCommand('Copy');

状态说明

var state = minder.queryCommandState('Copy');

state	说明
0	当前有选中的节点
-1	当前没有选中的节点

CopyStyle

⬅ 返回目录

拷贝选中节点的当前样式，包括字体、字号、粗体、斜体、背景色、字体色

minder.execCommand('CopyStyle');

状态说明

var state = minder.queryCommandState('CopyStyle');

state	说明
0	当前有选中的节点
-1	当前没有选中的节点

Cut

⬅ 返回目录

剪切当前选中的节点

快捷键：Ctrl + X

minder.execCommand('Cut');

状态说明

var state = minder.queryCommandState('Cut');

state	说明
0	当前有选中的节点
-1	当前没有选中的节点

EditNode

⬅ 返回目录

编辑选中的节点

minder.execCommand('EditNode');

状态说明

var state = minder.queryCommandState('EditNode');

state	说明
0	当前有选中的节点
-1	当前没有选中的节点

Expand

⬅ 返回目录

展开当前选中的节点，保证其可见

minder.execCommand('Expand', justParents);

参数说明

参数	类型	说明
justParents	bool	是否只展开到父亲 * false - （默认）保证选中的节点以及其子树可见 * true - 只保证选中的节点可见，不展开其子树

状态说明

var state = minder.queryCommandState('Expand');

state	说明
0	当前有选中的节点
-1	当前没有选中的节点

ExpandToLevel

⬅ 返回目录

展开脑图到指定的层级

minder.execCommand('ExpandToLevel', level);

参数说明

参数	类型	说明
level	number	指定展开到的层级，最少值为 1。

状态说明

var state = minder.queryCommandState('ExpandToLevel');

state	说明
0	一直可用

FontFamily

⬅ 返回目录

设置选中节点的字体

minder.execCommand('FontFamily', family);

参数说明

参数	类型	说明
family	string	表示字体的字符串

状态说明

var state = minder.queryCommandState('FontFamily');

state	说明
0	当前有选中的节点
-1	当前没有选中的节点

返回值

var value = minder.queryCommandValue('FontFamily');

返回首个选中节点的字体

FontSize

⬅ 返回目录

设置选中节点的字体大小

minder.execCommand('FontSize', size);

参数说明

参数	类型	说明
size	number	字体大小（px）

状态说明

var state = minder.queryCommandState('FontSize');

state	说明
0	当前有选中的节点
-1	当前没有选中的节点

返回值

var value = minder.queryCommandValue('FontSize');

返回首个选中节点的字体大小

ForeColor

⬅ 返回目录

设置选中节点的字体颜色

minder.execCommand('ForeColor', color);

参数说明

参数	类型	说明
color	string	表示颜色的字符串

状态说明

var state = minder.queryCommandState('ForeColor');

state	说明
0	当前有选中的节点
-1	当前没有选中的节点

返回值

var value = minder.queryCommandValue('ForeColor');

如果只有一个节点选中，返回已选中节点的字体颜色；否则返回 'mixed'。

Hand

⬅ 返回目录

切换抓手状态，抓手状态下，鼠标拖动将拖动视野，而不是创建选区

minder.execCommand('Hand');

状态说明

var state = minder.queryCommandState('Hand');

state	说明
0	当前不是抓手状态
1	当前是抓手状态

HyperLink

⬅ 返回目录

为选中的节点添加超链接

minder.execCommand('HyperLink', url, title);

参数说明

参数	类型	说明
url	string	超链接的 URL，设置为 null 移除
title	string	超链接的说明

状态说明

var state = minder.queryCommandState('HyperLink');

state	说明
0	当前有选中的节点
-1	当前没有选中的节点

返回值

var value = minder.queryCommandValue('HyperLink');

返回首个选中节点的超链接信息，JSON 对象： {url: url, title: title}

Image

⬅ 返回目录

为选中的节点添加图片

minder.execCommand('Image', url, title);

参数说明

参数	类型	说明
url	string	图片的 URL，设置为 null 移除
title	string	图片的说明

状态说明

var state = minder.queryCommandState('Image');

state	说明
0	当前有选中的节点
-1	当前没有选中的节点

返回值

var value = minder.queryCommandValue('Image');

返回首个选中节点的图片信息，JSON 对象： {url: url, title: title}

Italic

⬅ 返回目录

加斜选中的节点

快捷键：Ctrl + I

minder.execCommand('Italic');

状态说明

var state = minder.queryCommandState('Italic');

state	说明
0	当前有选中的节点
-1	当前没有选中的节点
1	当前已选中的节点已加斜

Layout

⬅ 返回目录

设置选中节点的布局<br>允许使用的布局可以使用 kityminder.Minder.getLayoutList() 查询

minder.execCommand('Layout', name);

参数说明

参数	类型	说明
name	string	布局的名称，设置为 null 则使用继承或默认的布局

状态说明

var state = minder.queryCommandState('Layout');

state	说明
0	当前有选中的节点
-1	当前没有选中的节点

返回值

var value = minder.queryCommandValue('Layout');

返回首个选中节点的布局名称

Move

⬅ 返回目录

指定方向移动当前视野

minder.execCommand('Move', dir, duration);

参数说明

参数	类型	说明
dir	string	移动方向 取值为 'left'，视野向左移动一半 取值为 'right'，视野向右移动一半 取值为 'up'，视野向上移动一半 取值为 'down'，视野向下移动一半
duration	number	视野移动的动画时长（单位 ms），设置为 0 不使用动画

状态说明

var state = minder.queryCommandState('Move');

state	说明
0	始终可用

Note

⬅ 返回目录

设置节点的备注信息

minder.execCommand('Note', note);

参数说明

参数	类型	说明
note	string	要设置的备注信息，设置为 null 则移除备注信息

状态说明

var state = minder.queryCommandState('Note');

state	说明
0	当前有选中的节点
-1	当前没有选中的节点

Paste

⬅ 返回目录

粘贴已复制的节点到每一个当前选中的节点上

快捷键：Ctrl + V

minder.execCommand('Paste');

状态说明

var state = minder.queryCommandState('Paste');

state	说明
0	当前有选中的节点
-1	当前没有选中的节点

PasteStyle

⬅ 返回目录

粘贴已拷贝的样式到选中的节点上，包括字体、字号、粗体、斜体、背景色、字体色

minder.execCommand('PasteStyle');

状态说明

var state = minder.queryCommandState('PasteStyle');

state	说明
0	当前有选中的节点，并且已经有复制的样式
-1	当前没有选中的节点，或者没有复制的样式

Priority

⬅ 返回目录

设置节点的优先级信息

minder.execCommand('Priority', value);

参数说明

参数	类型	说明
value	number	要设置的优先级（添加一个优先级小图标） 取值为 0 移除优先级信息； 取值为 1 - 9 设置优先级，超过 9 的优先级不渲染

状态说明

var state = minder.queryCommandState('Priority');

state	说明
0	当前有选中的节点
-1	当前没有选中的节点

Progress

⬅ 返回目录

设置节点的进度信息（添加一个进度小图标）

minder.execCommand('Progress', value);

参数说明

参数	类型	说明
value	number	要设置的进度 取值为 0 移除进度信息； 取值为 1 表示未开始； 取值为 2 表示完成 1/8； 取值为 3 表示完成 2/8； 取值为 4 表示完成 3/8； 其余类推，取值为 9 表示全部完成

状态说明

var state = minder.queryCommandState('Progress');

state	说明
0	当前有选中的节点
-1	当前没有选中的节点

Redo

⬅ 返回目录

重做下一步已回退的操作

minder.execCommand('Redo');

状态说明

var state = minder.queryCommandState('Redo');

state	说明
0	当前有可重做的内容
-1	当前没有可重做的内容

RemoveNode

⬅ 返回目录

移除选中的节点

minder.execCommand('RemoveNode');

状态说明

var state = minder.queryCommandState('RemoveNode');

state	说明
0	当前有选中的节点
-1	当前没有选中的节点

ResetLayout

⬅ 返回目录

重设选中节点的布局，如果当前没有选中的节点，重设整个脑图的布局

minder.execCommand('ResetLayout');

状态说明

var state = minder.queryCommandState('ResetLayout');

state	说明
0	始终可用

返回值

var value = minder.queryCommandValue('ResetLayout');

返回首个选中节点的布局名称

Resource

⬅ 返回目录

设置节点的资源标签

minder.execCommand('Resource', resource);

参数说明

参数	类型	说明
resource	Array<string>	要设置的资源列表，设置为空清除节点的资源标签

返回值

var value = minder.queryCommandValue('Resource');

返回当前选中节点中包含的资源（数组）

Template

⬅ 返回目录

设置当前脑图的模板

minder.execCommand('Template', name);

参数说明

参数	类型	说明
name	string	模板名称 允许使用的模板可以使用 kityminder.Minder.getTemplateList() 查询

状态说明

var state = minder.queryCommandState('Template');

state	说明
0	始终可用

返回值

var value = minder.queryCommandValue('Template');

返回当前的模板名称

Theme

⬅ 返回目录

设置当前脑图的主题

minder.execCommand('Theme', name);

参数说明

参数	类型	说明
name	string	主题名称 允许使用的主题可以使用 kityminder.Minder.getThemeList() 查询

状态说明

var state = minder.queryCommandState('Theme');

state	说明
0	始终可用

返回值

var value = minder.queryCommandValue('Theme');

返回当前的主题名称

Undo

⬅ 返回目录

回退上一步操作

minder.execCommand('Undo');

状态说明

var state = minder.queryCommandState('Undo');

state	说明
0	当前有可回退的内容
-1	当前没有可回退的内容

Zoom

⬅ 返回目录

缩放当前的视野到一定的比例（百分比）

minder.execCommand('Zoom', value);

参数说明

参数	类型	说明
value	number	设置的比例，取值 100 则为原尺寸

状态说明

var state = minder.queryCommandState('Zoom');

state	说明
0	始终可用

ZoomIn

⬅ 返回目录

放大当前的视野到下一个比例等级（百分比）

快捷键：=

minder.execCommand('ZoomIn');

状态说明

var state = minder.queryCommandState('ZoomIn');

state	说明
0	如果当前脑图的配置中还有下一个比例等级
-1	其它情况

ZoomOut

⬅ 返回目录

缩小当前的视野到上一个比例等级（百分比）

快捷键：-

minder.execCommand('ZoomOut');

状态说明

var state = minder.queryCommandState('ZoomOut');

state	说明
0	如果当前脑图的配置中还有上一个比例等级
-1	其它情况