jsmind 0.8.7 → 0.8.8-patch

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. package/README.md +2 -2
  2. package/es6/jsmind.draggable-node.js +1 -1
  3. package/es6/jsmind.draggable-node.js.map +1 -1
  4. package/es6/jsmind.js +1 -1
  5. package/es6/jsmind.js.map +1 -1
  6. package/es6/jsmind.screenshot.js +1 -1
  7. package/es6/jsmind.screenshot.js.map +1 -1
  8. package/package.json +32 -7
  9. package/types/generated/index.d.ts +8 -0
  10. package/types/generated/jsmind.common.d.ts +66 -0
  11. package/types/generated/jsmind.d.ts +314 -0
  12. package/types/generated/jsmind.data_provider.d.ts +56 -0
  13. package/types/generated/jsmind.dom.d.ts +59 -0
  14. package/types/generated/jsmind.format.d.ts +100 -0
  15. package/types/generated/jsmind.graph.d.ts +180 -0
  16. package/types/generated/jsmind.layout_provider.d.ts +182 -0
  17. package/types/generated/jsmind.mind.d.ts +121 -0
  18. package/types/generated/jsmind.node.d.ts +62 -0
  19. package/types/generated/jsmind.option.d.ts +64 -0
  20. package/types/generated/jsmind.plugin.d.ts +21 -0
  21. package/types/generated/jsmind.shortcut_provider.d.ts +52 -0
  22. package/types/generated/jsmind.util.d.ts +26 -0
  23. package/types/generated/jsmind.view_provider.d.ts +347 -0
  24. package/types/generated/plugins/jsmind.draggable-node.d.ts +229 -0
  25. package/types/generated/plugins/jsmind.screenshot.d.ts +83 -0
  26. package/types/tsconfig.declaration.json +19 -0
  27. package/docs/en/1.usage.md +0 -243
  28. package/docs/en/2.options.md +0 -265
  29. package/docs/en/3.operation.md +0 -156
  30. package/docs/en/4.contribution.md +0 -40
  31. package/docs/en/5.development.md +0 -88
  32. package/docs/en/experimental-features.md +0 -27
  33. package/docs/en/index.md +0 -32
  34. package/docs/en/plugin-screenshot.md +0 -72
  35. package/docs/index.md +0 -19
  36. package/docs/zh/1.usage.md +0 -273
  37. package/docs/zh/2.options.md +0 -270
  38. package/docs/zh/3.operation.md +0 -159
  39. package/docs/zh/4.contribution.md +0 -43
  40. package/docs/zh/5.development.md +0 -81
  41. package/docs/zh/experimental-features.md +0 -27
  42. package/docs/zh/index.md +0 -32
  43. package/docs/zh/plugin-screenshot.md +0 -74
  44. package/example/1_basic.html +0 -77
  45. package/example/1_basic_cn.html +0 -77
  46. package/example/2_features.html +0 -211
  47. package/example/2_features.js +0 -462
  48. package/example/2_features_cn.html +0 -218
  49. package/example/3_requirejs.html +0 -59
  50. package/example/ant.png +0 -0
  51. package/example/data_example.json +0 -95
  52. package/example/demo.html +0 -107
  53. package/js/README.md +0 -7
  54. package/js-legacy/jsmind.draggable-node.js +0 -389
  55. package/js-legacy/jsmind.js +0 -3128
  56. package/js-legacy/jsmind.screenshot.js +0 -351
@@ -1,72 +0,0 @@
1
- [Table of Contents](index.md)
2
-
3
- * [Usage](1.usage.md)
4
- * [Options](2.options.md)
5
- * [Operation](3.operation.md)
6
- * [Experimental Features](experimental-features.md)
7
- * [Screenshot (Export as Image) *](plugin-screenshot.md)
8
- * [Contribution](4.contribution.md)
9
- * [Development Guide](5.development.md)
10
-
11
- Screenshot (Export as Image) <sup>[experimental](experimental-features.md)</sup>
12
- ===
13
-
14
- > It's strongly recommended that you read [Experimental Features](experimental-features.md) to fully understand the risks before using this feature.
15
-
16
- This feature can support to export mind maps as png images.
17
-
18
- ```html
19
-
20
- <!-- style -->
21
- <link type="text/css" rel="stylesheet" href="https://unpkg.com/jsmind@0.8.7/style/jsmind.css" />
22
-
23
- <!-- jsMind -->
24
- <script type="text/javascript" src="https://unpkg.com/jsmind@0.8.7/es6/jsmind.js"></script>
25
-
26
- <!-- dependency of screenshot -->
27
- <script type="text/javascript" src="https://unpkg.com/dom-to-image@2.6.0/dist/dom-to-image.min.js" ></script>
28
-
29
- <!-- screenshot plugin -->
30
- <script type="text/javascript" src="https://unpkg.com/jsmind@0.8.7/es6/jsmind.screenshot.js"></script>
31
-
32
-
33
- <script>
34
- var jm = new jsMind(options);
35
- jm.show(mind_data);
36
- // export current mindmap to an image
37
- jm.shoot()
38
- </script>
39
-
40
- ```
41
-
42
- If you use npm, please install `jsmind` and `dom-to-image`
43
-
44
- ```bash
45
- npm install jsmind
46
- npm install dom-to-image
47
- ```
48
-
49
- And then use it the same way on the page.
50
-
51
- ```html
52
- <script>
53
- import domtoimage from 'dom-to-image';
54
- import jsMind from 'jsmind'
55
- import 'jsmind/screenshot'
56
- import 'jsmind/style/jsmind.css'
57
-
58
- // ...
59
-
60
- var jm = new jsMind(options);
61
- jm.show(mind_data);
62
- // export current mindmap to an image
63
- jm.shoot()
64
- </script>
65
- ```
66
-
67
- copyright notice
68
- ===
69
-
70
- Reproduction and deduction are prohibited.
71
-
72
- The jsMind project is still being updated and the corresponding documentation is updated at the same time as the version is updated. In order to avoid confusion to the user, it is forbidden to reprint this document without written permission and to make changes of any kind to this document.
package/docs/index.md DELETED
@@ -1,19 +0,0 @@
1
- ## 中文
2
-
3
- * [目录](zh/index.md)
4
- * [基本用法](zh/1.usage.md)
5
- * [选项](zh/2.options.md)
6
- * [界面操控](zh/3.operation.md)
7
- * [实验性功能](zh/experimental-features.md)
8
- * [参与贡献](zh/4.contribution.md)
9
- * [贡献代码指南](zh/5.development.md)
10
-
11
- ## English
12
-
13
- * [Table of Contents](en/index.md)
14
- * [Usage](en/1.usage.md)
15
- * [Options](en/2.options.md)
16
- * [API / Operation](en/3.operation.md)
17
- * [Experimental Features](en/experimental-features.md)
18
- * [Contribution](en/4.contribution.md)
19
- * [Development Guide](en/5.development.md)
@@ -1,273 +0,0 @@
1
- [目录](index.md)
2
-
3
- * [基本用法 *](1.usage.md)
4
- * [选项](2.options.md)
5
- * [界面操控](3.operation.md)
6
- * [实验性功能](experimental-features.md)
7
- * [截图 (导出图片)](plugin-screenshot.md)
8
- * [参与贡献](4.contribution.md)
9
- * [贡献代码指南](5.development.md)
10
-
11
- 1.1. 基本框架
12
- ===
13
-
14
- 首先,需要在页面上引用 jsmind.js 和 jsmind.css 两个文件,这里我们引用的是 CDN 上的资源,请注意使用最新的版本。
15
-
16
-
17
- ```html
18
- <link type="text/css" rel="stylesheet" href="https://unpkg.com/jsmind@0.8.7/style/jsmind.css" />
19
-
20
- <script type="text/javascript" src="https://unpkg.com/jsmind@0.8.7/es6/jsmind.js"></script>
21
- ```
22
-
23
- > 常用的 CDN 有 [UNPKG](https://unpkg.com/jsmind/),[jsDelivr](https://www.jsdelivr.com/package/npm/jsmind/),以及 jsDelivr 的[国内镜像](https://jsd.onmicrosoft.cn/npm/jsmind/)。文件路径大概像这样:
24
- > - https://unpkg.com/jsmind@0.8.7/es6/jsmind.js
25
- > - https://cdn.jsdelivr.net/npm/jsmind@0.8.7/es6/jsmind.js
26
- > - https://jsd.onmicrosoft.cn/npm/jsmind@0.8.7/es6/jsmind.js
27
- >
28
- > 示例中url中都有版本号,强烈建议你在项目里也指明版本号,以避免版本升级给你的项目带来风险。访问 [NPM 上的 jsMind](https://www.npmjs.com/package/jsmind) 可以获取 jsmind 的最新版本号。
29
-
30
- 如果希望能够通过鼠标拖拽的方式移动节点,需要额外引用 jsmind.draggable-node.js 文件
31
-
32
- ```html
33
- <script type="text/javascript" src="https://unpkg.com/jsmind@0.8.7/es6/jsmind.draggable-node.js"></script>
34
- ```
35
-
36
- 其次,要为 jsMind 准备一个容器,jsMind 将在这个容器里显示思维导图。可自行定义容器的id、大小及样式。
37
-
38
- ```html
39
- <div id="jsmind_container"></div>
40
- ```
41
-
42
- 最后,添加下面一段代码即可显示一个空白的思维导图:
43
-
44
- ```html
45
- <script type="text/javascript">
46
- var options = { // options 将在下一章中详细介绍
47
- container:'jsmind_container', // [必选] 容器的ID,或者为容器的对象
48
- editable:true, // [可选] 是否启用编辑
49
- theme:'orange' // [可选] 主题
50
- };
51
- var jm = new jsMind(options);
52
- jm.show();
53
- </script>
54
- ```
55
-
56
- 或者,使用下面的代码显示一个包含既定内容的思维导图:
57
-
58
- ```html
59
- <script type="text/javascript">
60
- var mind = { /* jsMind 数据,详见下一节的说明 */ };
61
- var options = {
62
- container:'jsmind_container',
63
- editable:true,
64
- theme:'orange'
65
- };
66
-
67
- var jm = new jsMind(options);
68
- // 让 jm 显示这个 mind 即可
69
- jm.show(mind);
70
- </script>
71
- ```
72
-
73
- 1.2. 数据格式
74
- ===
75
-
76
- jsMind 支持三种数据格式,分别是 `node_tree`、`node_array` 和 `freemind` 格式。jsMind 可以加载其中任一种格式,也能将数据导出为任一种格式。
77
-
78
- 下面是三种数据格式的简单示例:
79
-
80
- A. `node_tree` 格式,jsMind 的默认数据格式
81
- ---
82
-
83
- ```javascript
84
- var mind = {
85
- /* 元数据,定义思维导图的名称、作者、版本等信息 */
86
- "meta":{
87
- "name":"jsMind-demo-tree",
88
- "author":"hizzgdev@163.com",
89
- "version":"0.2"
90
- },
91
- /* 数据格式声明 */
92
- "format":"node_tree",
93
- /* 数据内容 */
94
- "data":{"id":"root","topic":"jsMind","children":[
95
- {"id":"easy","topic":"Easy","direction":"left","expanded":false,"children":[
96
- {"id":"easy1","topic":"Easy to show"},
97
- {"id":"easy2","topic":"Easy to edit"},
98
- {"id":"easy3","topic":"Easy to store"},
99
- {"id":"easy4","topic":"Easy to embed"}
100
- ]},
101
- {"id":"open","topic":"Open Source","direction":"right","expanded":true,"children":[
102
- {"id":"open1","topic":"on GitHub"},
103
- {"id":"open2","topic":"BSD License"}
104
- ]},
105
- {"id":"powerful","topic":"Powerful","direction":"right","children":[
106
- {"id":"powerful1","topic":"Base on Javascript"},
107
- {"id":"powerful2","topic":"Base on HTML5"},
108
- {"id":"powerful3","topic":"Depends on you"}
109
- ]},
110
- {"id":"other","topic":"test node","direction":"left","children":[
111
- {"id":"other1","topic":"I'm from local variable"},
112
- {"id":"other2","topic":"I can do everything"}
113
- ]}
114
- ]}
115
- };
116
- ```
117
-
118
- B. `node_array` 格式
119
- ---
120
-
121
- ```javascript
122
- var mind = {
123
- /* 元数据,定义思维导图的名称、作者、版本等信息 */
124
- "meta":{
125
- "name":"example",
126
- "author":"hizzgdev@163.com",
127
- "version":"0.2"
128
- },
129
- /* 数据格式声明 */
130
- "format":"node_array",
131
- /* 数据内容 */
132
- "data":[
133
- {"id":"root", "isroot":true, "topic":"jsMind"},
134
-
135
- {"id":"easy", "parentid":"root", "topic":"Easy", "direction":"left"},
136
- {"id":"easy1", "parentid":"easy", "topic":"Easy to show"},
137
- {"id":"easy2", "parentid":"easy", "topic":"Easy to edit"},
138
- {"id":"easy3", "parentid":"easy", "topic":"Easy to store"},
139
- {"id":"easy4", "parentid":"easy", "topic":"Easy to embed"},
140
-
141
- {"id":"open", "parentid":"root", "topic":"Open Source", "expanded":false, "direction":"right"},
142
- {"id":"open1", "parentid":"open", "topic":"on GitHub"},
143
- {"id":"open2", "parentid":"open", "topic":"BSD License"},
144
-
145
- {"id":"powerful", "parentid":"root", "topic":"Powerful", "direction":"right"},
146
- {"id":"powerful1", "parentid":"powerful", "topic":"Base on Javascript"},
147
- {"id":"powerful2", "parentid":"powerful", "topic":"Base on HTML5"},
148
- {"id":"powerful3", "parentid":"powerful", "topic":"Depends on you"},
149
- ]
150
- };
151
- ```
152
-
153
- C. `freemind` 格式
154
- ---
155
-
156
- ```javascript
157
- var mind = {
158
- /* 元数据,定义思维导图的名称、作者、版本等信息 */
159
- "meta":{
160
- "name":"example",
161
- "author":"hizzgdev@163.com",
162
- "version":"0.2"
163
- },
164
- /* 数据格式声明 */
165
- "format":"freemind",
166
- /* 数据内容 */
167
- "data":"<map version=\"1.0.1\"> <node ID=\"root\" TEXT=\"jsMind\" > <node ID=\"easy\" POSITION=\"left\" TEXT=\"Easy\" > <node ID=\"easy1\" TEXT=\"Easy to show\" /> <node ID=\"easy2\" TEXT=\"Easy to edit\" /> <node ID=\"easy3\" TEXT=\"Easy to store\" /> <node ID=\"easy4\" TEXT=\"Easy to embed\" /> </node> <node ID=\"open\" POSITION=\"right\" TEXT=\"Open Source\" > <node ID=\"open1\" TEXT=\"on GitHub\" /> <node ID=\"open2\" TEXT=\"BSD License\" /> </node> <node ID=\"powerful\" POSITION=\"right\" TEXT=\"Powerful\" > <node ID=\"powerful1\" TEXT=\"Base on Javascript\" /> <node ID=\"powerful2\" TEXT=\"Base on HTML5\" /> <node ID=\"powerful3\" TEXT=\"Depends on you\" /> </node> <node ID=\"other\" POSITION=\"left\" TEXT=\"test node\" > <node ID=\"other1\" TEXT=\"I'm from local variable\" /> <node ID=\"other2\" TEXT=\"I can do everything\" /> </node> </node> </map>"
168
- };
169
- ```
170
-
171
- 注
172
- ---
173
-
174
- 除 freemind 格式外,其余两种格式的基本数据结构如下:
175
-
176
- ```javascript
177
-
178
- {
179
- "id":"open", // [必选] ID, 所有节点的ID不应有重复,否则ID重复的结节将被忽略
180
- "topic":"Open Source", // [必选] 节点上显示的内容
181
- "direction":"right", // [可选] 节点的方向,此数据仅在第一层节点上有效,目前仅支持 left 和 right 两种,默认为 right
182
- "expanded":true, // [可选] 该节点是否是展开状态,默认为 true
183
- }
184
-
185
- ```
186
-
187
- 1.3. 主题
188
- ===
189
-
190
- jsMind 默认提供了 15 种主题,你可以访问[功能示例](http://hizzgdev.github.io/jsmind/example/2_features.html)页面浏览这些主题。
191
-
192
- * primary
193
- * warning
194
- * danger
195
- * success
196
- * info
197
- * greensea
198
- * nephrite
199
- * belizehole
200
- * wisteria
201
- * asphalt
202
- * orange
203
- * pumpkin
204
- * pomegranate
205
- * clouds
206
- * asbestos
207
-
208
- 当然,你也可以添加自己的主题。只需在 jsmind.css 中按照以下格式添加样式定义即可:
209
-
210
- ```css
211
- /* greensea theme */ /* greensea 即是主题名 */
212
- jmnodes.theme-greensea jmnode{background-color:#1abc9c;color:#fff;} /* 节点样式 */
213
- jmnodes.theme-greensea jmnode:hover{background-color:#16a085;} /* 鼠标悬停的节点样式 */
214
- jmnodes.theme-greensea jmnode.selected{background-color:#11f;color:#fff;} /* 选中的节点样式 */
215
- jmnodes.theme-greensea jmnode.root{} /* 根节点样式 */
216
- jmnodes.theme-greensea jmexpander{} /* 展开/关闭节点的控制点样式 */
217
- jmnodes.theme-greensea jmexpander:hover{} /* 鼠标悬停展开/关闭节点的控制点样式 */
218
- ```
219
-
220
- 1.4. 样式
221
- ===
222
-
223
- 除了上述主题外,你还可以为每一个节点设置单独的样式,目前 jsMind 支持以下自定义样式:
224
-
225
- * background-color: 节点的背景颜色,如 `#1abc9c`, `blue`
226
- * foreground-color: 节点的文本颜色,如 `#1abc9c`, `blue`
227
- * width: 节点的宽度(px),如 `400`
228
- * height: 节点的高度(px),如 `400`
229
- * font-size: 节点的文本字体大小(px),如 `32`
230
- * font-weight: 节点的文本重量,如 `bold`
231
- * font-style: 节点的文本样式,如 `italic`
232
- * background-image: 节点的背景图片,可使用 url,如 `http://fakeurl.com/fake-picture.png`,或 data url 形式,如 `data:image/png;base64,...`
233
- * background-rotation: 节点的背景图片旋转角度,如 `30`
234
- * leading-line-color: 节点的引导线颜色,如 `#1abc9c`, `blue`。
235
-
236
- 设置方法:
237
-
238
- * 通过 API 配置:在 data 参数里添加上述配置即可,api 定义见 [[3.4. 界面操控 - 添加节点](3.operation.md)]
239
-
240
-
241
- ```javascript
242
- let data = {'width': 400, 'leading-line-color': '#33ff33'}
243
- jm.add_node(....., data)
244
- ```
245
-
246
- * 在数据定义(数据文件)中配置:把上述参数添加到 `node` 的定义中即可,如:
247
-
248
- ```javascript
249
-
250
- var mind = {
251
- ...
252
- format: 'node_tree',
253
- data: {
254
- id: 'root',
255
- topic: 'jsMind',
256
- children: [
257
- {
258
- 'id': 'image-node',
259
- 'background-image': 'ant.png',
260
- 'width': '100',
261
- 'height': '100',
262
- }
263
- ],
264
- ...
265
- }
266
- ```
267
-
268
- 版权声明
269
- ===
270
-
271
- 禁止转载、禁止演绎。
272
-
273
- jsMind 项目仍在不断升级变化,版本更新时会同时更新对应的文档。为避免给使用者带来困惑,在没有得到书面许可前,禁止转载本文档,同时禁止对本文档进行任何形式的更改。
@@ -1,270 +0,0 @@
1
- [目录](index.md)
2
-
3
- * [基本用法](1.usage.md)
4
- * [选项 *](2.options.md)
5
- * [界面操控](3.operation.md)
6
- * [实验性功能](experimental-features.md)
7
- * [截图 (导出图片)](plugin-screenshot.md)
8
- * [参与贡献](4.contribution.md)
9
- * [贡献代码指南](5.development.md)
10
-
11
- 2.1. 综述
12
- ===
13
-
14
- 此页面已过时,并将不会再更新,请访问新版的[选项](options/index.md)页面获取帮助。
15
- ---
16
-
17
- 上一章的示例中简单提到了 jsMind 的 options 对象:
18
-
19
- ```javascript
20
- var options = {
21
- container:'jsmind_container', // [必选] 容器的ID
22
- editable:true, // [可选] 是否启用编辑
23
- theme:'orange' // [可选] 主题
24
- };
25
- var jm = new jsMind(options);
26
- ```
27
-
28
- 不过这只是很少的一部分,jsMind 的 options 对象的完整定义如下所示:
29
-
30
- ```javascript
31
- options = {
32
- container : '', // [必选] 容器的ID
33
- editable : false, // 是否启用编辑
34
- theme : null, // 主题
35
- mode :'full', // 布局模式
36
- support_html : true, // 是否支持节点里的HTML元素
37
- log_level: 'info', // 日志级别
38
- view:{
39
- engine: 'canvas', // 思维导图各节点之间线条的绘制引擎
40
- hmargin:100, // 思维导图距容器外框的最小水平距离
41
- vmargin:50, // 思维导图距容器外框的最小垂直距离
42
- line_width:2, // 思维导图线条的粗细
43
- line_color:'#555', // 思维导图线条的颜色
44
- line_style:'curved',// 思维导图线条的样式,直线(straight)或者曲线(curved)
45
- custom_line_render: null, // 自定义的线条渲染方法
46
- draggable: false, // 当容器不能完全容纳思维导图时,是否允许拖动画布代替鼠标滚动
47
- hide_scrollbars_when_draggable: false, // 当设置 draggable = true 时,是否隐藏滚动条
48
- node_overflow: 'hidden', // 节点文本过长时的样式
49
- zoom: { // 配置缩放
50
- min: 0.5, // 最小的缩放比例
51
- max: 2.1, // 最大的缩放比例
52
- step: 0.1, // 缩放比例间隔
53
- },
54
- custom_node_render: null, // 自定义的节点渲染方法
55
- },
56
- layout:{
57
- hspace:30, // 节点之间的水平间距
58
- vspace:20, // 节点之间的垂直间距
59
- pspace:13, // 节点与连接线之间的水平间距(用于容纳节点收缩/展开控制器)
60
- cousin_space:0 // 相邻节点的子节点之间的额外的垂直间距
61
- },
62
- shortcut:{
63
- enable:true, // 是否启用快捷键
64
- handles:{}, // 命名的快捷键事件处理器
65
- mapping:{ // 快捷键映射
66
- addchild : [45, 4096+13], // <Insert>, <Ctrl> + <Enter>
67
- addbrother : 13, // <Enter>
68
- editnode : 113, // <F2>
69
- delnode : 46, // <Delete>
70
- toggle : 32, // <Space>
71
- left : 37, // <Left>
72
- up : 38, // <Up>
73
- right : 39, // <Right>
74
- down : 40, // <Down>
75
- }
76
- },
77
- };
78
- ```
79
-
80
- 以上选项是 jsMind 的默认选项,除 container 之外,其它选项都是可选的,你可以添加相应的选项以覆盖这些默认选项。
81
-
82
- 下面将对这些选项进行详细介绍。
83
-
84
- 2.2. 常规选项
85
- ===
86
-
87
- **container** : (string) [必选] 容器的ID
88
-
89
- > 实例化一个 jsMind 时,此参数不可缺省。jsMind 通过此参数查找页面元素,并将思维导图输出到该元素中。为了便于控制思维导图的大小和位置,请使用[块元素][1]作为思维导图的容器,如`<div>`。
90
-
91
- > 你可以给该元素进行修饰,但是一般仅限于设置其大小、位置、边框等;如果想改变思维导图的字体、字号、背景颜色、前景颜色等,建议通过添加自定义主题的方式进行处理。
92
-
93
- **editable** : (bool) 是否启用编辑
94
-
95
- > 该参数控制是否支持在思维导图上进行编辑,jsMind 目前提供的编辑行为有添加节点、删除节点、修改节点标题、移动节点位置等,如果该参数设置为 true,将可以使用 API 进行以上这些操作,否则这些 API 将不会生效。默认情况下,该参数的值为 false 。
96
-
97
- > 需要注意的是,jsMind 仅提供了编辑接口和少量的快捷键支持,并未提供完整的编辑功能,此参数仅用于限制这些 API 的使用。
98
-
99
- **theme** : (string) 主题
100
-
101
- > 指定 jsMind 的主题名。
102
-
103
- **mode** : (string) 布局模式
104
-
105
- > 当往脑图里添加一级子节点时,jsMind 将根据此参数决定把节点放置在哪一侧。目前支持两种布局模式:
106
-
107
- > * `full` - 子节点动态分布在根节点两侧 [默认值]
108
- > * `side` - 子节点只分布在根节点右侧
109
-
110
- > 需要注意的是,此参数只在添加节点时(`jsMind.add_node(...)`)生效。
111
-
112
- **support_html** : (bool) 是否支持节点里的HTML元素
113
-
114
- > 该参数的默认值为 true ,含义为允许在节点的标题中使用 HTML 代码,如果你愿意,你甚至可以在节点标题里插入一个表格`<table>`。如果你希望标题中只有纯文本,请将该参数设为 false 。
115
-
116
- > 需要注意的是,在 freemind 中,节点的样式是使用 html 语言进行控制的,如果你使用 freemind 格式的数据时,建议将此参数设置为 true。
117
-
118
- **log_level** : (string) log 级别
119
-
120
- > log 级别一共有五种: `debug`/`info`/`warn`/`error`/`disable`,默认设置为 `info`,如果需要关闭所有日志,请设置为 `disable`。
121
-
122
- 2.3. 排版选项
123
- ===
124
-
125
- **view.engine** : (string) 思维导图各节点之间线条的绘制引擎
126
-
127
- > jsMind 现支持两种线条的绘制引擎:
128
-
129
- > * `canvas` - 把线条绘制在 canvas 上 [默认值]
130
- > * `svg` - 使用 svg 绘制线条,当思维导图的节点很多,面积巨大的时候,使用该模式能带来显著的性能提升
131
-
132
- **view.enable_device_pixel_ratio** : (bool) 按设备像素比例绘制高清思维导图。 (0.8.5 及以上版本支持)
133
-
134
- > 此参数仅用于改善 canvas 的绘制效果,当绘制引擎设置为 svg 时则无须设置。
135
-
136
- **view.hmargin** : (number) 思维导图距容器外框的最小水平距离(像素)
137
- **view.vmargin** : (number) 思维导图距容器外框的最小垂直距离(像素)
138
-
139
- > 这两个参数决定了思维导图与容器的边框能距离多近。把思维导图本身作为一个对象的话,这两个参数就类似该对象的 margin(css) 属性。这两个参数的默认值为 container 的宽和高。
140
-
141
- **view.line_width** : (number) 思维导图线条的粗细(像素)
142
- **view.line_color** : (string) 思维导图线条的颜色(html的颜色表示方法)。如果一个 `node` 设置了 `data.leading-line-color`,此选项将会被覆盖
143
-
144
- > 默认情况下,线条的粗细是2px,颜色是深灰色(#555)。
145
-
146
- **view.line_style** : (string) 思维导图线条的样式。可用的选项有:
147
-
148
- > * `curved` 表示曲线 [默认值]
149
- > * `straight` 表示直线
150
-
151
- **view.custom_line_render** : (function) 自定义思维导图线条的渲染方法
152
-
153
- > * 方法参数签名: `function custom_line_render({ctx, start_point: {x, y}, end_point: {x, y}}):void`
154
- > * `this`对应[当前渲染的线条对象](https://github.com/hizzgdev/jsmind/blob/master/src/jsmind.graph.js),`ctx` 是一个 canvas 上下文对象或一个标签名为`path`的DOM对象,具体取决于`view.engine`的值,`start_point` 和 `end_point` 是起始点的坐标对象,坐标对象包含 `x` 和 `y` 属性。
155
- > * 注意: 如果你想要使用[`this`](https://github.com/hizzgdev/jsmind/blob/master/src/jsmind.graph.js)对象, 请不要使用箭头函数
156
-
157
- **view.draggable** : (bool) 当容器不能完全容纳思维导图时,是否允许拖动画布代替鼠标滚动
158
-
159
- > 当思维导图不能在容器中完全显示时,默认情况下容器内会出现滚动条。开启此选项后,将允许通过拖拽画布的方式查看思维导图的不同部分。此参数默认值为 `false` (不开启此功能)
160
-
161
- **view.hide_scrollbars_when_draggable** : (bool) 当设置 draggable = true 时,是否隐藏滚动条
162
-
163
- > 此参数仅当 `view.draggable` 为 true 时生效,其用于设置是否隐藏水平和垂直容器内的滚动条。
164
- > 此参数的默认值为 `false` (显示滚动条),当设置为 `true` 时,容器内的滚动条将会被隐藏,用户无法通过滚动鼠标滚轮的方式查看思维导图的不同部分。
165
-
166
- **view.node_overflow** : (string) 节点文本过长时的样式 (0.5.3 及以上版本支持)
167
-
168
- > 节点文本过长时,jsMind 支持两种样式:
169
-
170
- > * `hidden` - 隐藏部分文本以保持脑图的整体易读性 [默认值]
171
- > * `wrap` - 对文本进行换行,以展示全部文本内容
172
-
173
- **view.zoom** : (object) 脑图缩放配置 (0.6.3 及以上版本支持)
174
- > * min - 最小的缩放比例,默认 0.5
175
- > * max - 最大的缩放比例,默认 2.1
176
- > * step - 缩放比例间隔,默认 0.1
177
-
178
- **view.custom_node_render** : (function) 脑图节点的自定义渲染方法 (0.7.6 及以上版本支持)
179
-
180
- > 此选项可用于修改 jsMind 默认的渲染逻辑,此参数为一个 javascript 方法,其方法签名为 `function (jm, element, node): boolean `。其返回值用于表示是否已经对此节点进行了渲染,如果返回 `true`, jsMind 将不会再次渲染此节点;如果返回 false, jsMind 将使用默认渲染逻辑对此节点进行渲染。
181
-
182
- **view.expander_style** : (string) 子节点展开控制器的样式 (0.7.8 及以上版本支持)
183
-
184
- > * `char` - 在展开控制器上显示 `-`, `+` 用于表示节点的展开状态 [default]
185
- > * `number` - 在展开控制器上显示子节点的数量,多于100个子节点时将显示 `...`
186
-
187
- **layout.hspace** : (number) 节点之间的水平间距(像素)
188
- **layout.vspace** : (number) 节点之间的垂直间距(像素)
189
-
190
- > 这两个参数相当于节点对象的 margin(css)属性,水平方向上默认值为 30 像素,垂直方向上默认值为 20 像素。
191
-
192
- **layout.pspace** : (number) 节点收缩/展开控制器的尺寸(像素)
193
-
194
- > 如果某一节点(根节点除外)存在下级节点,则此节点外侧则会显示出收缩/展开下级节点的控制器,此参数用于设置此控制器的大小(宽和高),默认值为 13 像素。
195
-
196
- **layout.cousin_space** : (number) 相邻节点的子节点之间的额外的垂直间距(像素)(0.5.5 及以上版本支持)
197
-
198
- > 该参数默认值为零,即不添加额外的间距。
199
-
200
- 2.4. 快捷键
201
- ===
202
-
203
- **shortcut.enable** : (bool) 是否启用快捷键
204
-
205
- > 该参数用于控制是否可以在jsMind界面上使用键盘快捷键对思维导图进行编辑(或其它操作),默认值为 true,即启用快捷键。
206
-
207
- **shortcut.handles** : (object{string : function}) 命名的快捷键事件处理器
208
-
209
- > jsMind提供了一些常用的处理器,用于操作思维导图(参见下一节),该参数提供了定义额外处理器的能力。
210
- > 该参数是一个 string->function(jsmind,event) 的集合,string 指名了该处理器的名称,function 则是这个处理器具体要执行的逻辑,在下一节的 shortcut.mapping 的配置中,将把处理器的名称绑定到具体的按键上,实现快捷操作的目的。比如以下代码就定义了一个处理器:
211
-
212
- ```javascript
213
- handles : {
214
- 'dosomething' : function(jm,e){
215
- // do something...
216
- },
217
- 'dosomeotherthing' : function(jm,e){
218
- // do some other things
219
- }
220
- ...
221
- }
222
- ```
223
-
224
- **shortcut.mapping** : (object{string : number | [number]}) 快捷键映射配置
225
-
226
- > 该参数用于配置具体的按键与处理器之间的对应关系,此代码显示了默认情况下的对应关系,如 [Insert] 键的代码是 45 ,可用于添加一个子节点,而 112 代表的是 [F1] 键,用于 dosomething。
227
- > 提示:还可以为一个处理器配置多个快捷键,把键码替换为数组即可。
228
-
229
- ```javascript
230
- mapping:{ // handle mapping.
231
- addchild : [45, 4096+13], // <Insert>, <Ctrl> + <Enter>
232
- addbrother : 13, // <Enter>
233
- editnode : 113, // <F2>
234
- delnode : 46, // <Delete>
235
- toggle : 32, // <Space>
236
- left : 37, // <Left>
237
- up : 38, // <Up>
238
- right : 39, // <Right>
239
- down : 40, // <Down>
240
-
241
- // 示例
242
- dosomething: 112, // <F1>
243
- }
244
- ```
245
-
246
- > 除了上述这种单一按键的情况,jsMind新增了对组合按键的支持,组合快捷键的代码为常规按键的代码加上功能键的标识代码。
247
- > 目前支持四种功能键,对应的标识代码分别为:
248
-
249
- > * Meta : 8192
250
- > * Ctrl : 4096
251
- > * ALT : 2048
252
- > * SHIFT : 1024
253
-
254
- > 以下是一些示例:
255
-
256
- ```javascript
257
- mapping:{
258
- addchild : 4096 + 73, // <Ctrl> + <I>
259
- delnode : 4096 + 2048 + 68, // <Ctrl> + <ALT> + <D>
260
- }
261
- ```
262
-
263
- 版权声明
264
- ===
265
-
266
- 禁止转载、禁止演绎。
267
-
268
- jsMind 项目仍在不断升级变化,版本更新时会同时更新对应的文档。为避免给使用者带来困惑,在没有得到书面许可前,禁止转载本文档,同时禁止对本文档进行任何形式的更改。
269
-
270
- [1]:http://www.nowamagic.net/librarys/veda/detail/1190 "CSS块级元素、内联元素概念"