JsMind
预览版本
jsMind V2 的编程 API 目前是预览版本,之后还会更新。请随时查阅本文档,以了解当前的接口。
jsmind 包的默认导出。在 UMD 构建中也可以通过全局变量 jsMind 使用。
本页由 TypeDoc 根据已发布的类型声明 dist/jsmind.d.ts 生成。
JsMind
类
jsMind 思维导图操作的主类。
mind
mind: JmMind | null当前已打开的思维导图;如果没有打开则为 null。
options
options: JsMindOptions该 jsMind 实例的选项。
Mind
static Mind: typeof JmMind思维导图模型类。用 new jsMind.Mind() 构造一张图,再把它传给 JsMind.open。
NodeSide
static NodeSide: { Center: 0; SideA: 1; SideB: -1 }将节点放在左侧、右侧或中间时使用的方向值。与类型声明中的 JmNodeSide 枚举是同一个对象。
Serializer
static Serializer: typeof JmMindSerializerFactory序列化器工厂。支持的格式是 jsMind.Serializer.create('json') 和 jsMind.Serializer.create('freemind')。
Author
static get Author(): string获取 jsMind 的作者。
返回值: 作者字符串。
Version
static get Version(): string获取 jsMind 的版本。
返回值: 版本字符串。
close
close(): void如果当前有打开的思维导图,则关闭它。
说明
调用 close 之后,JsMind.mind 为 null,直到再次 JsMind.open 打开另一张图。
exportImage
exportImage(options?: JmExportImageOptions): Promise<JmExportImageResult>将已打开的思维导图渲染为图片。
尺寸是已渲染内容自身的尺寸:容器内的空白会进入画面,大于容器的导图也不会被裁切。
返回值: 已编码的图片(Blob)及其像素尺寸。
异常
JsMindError如果当前没有打开的思维导图,或浏览器无法编码结果。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
options (可选) | JmExportImageOptions | 缩放、格式、质量和背景透明度。默认是 2 倍的 PNG。 |
open
open(mind: JmMind): Promise<void>打开一张思维导图。
返回值: 当思维导图打开完成后,该 Promise 完成(无返回值)。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
mind | JmMind | 要打开的思维导图实例。 |
serialize
serialize(): string将当前思维导图序列化为 JSON。
返回值: 思维导图的 JSON 字符串表示。
异常
Error如果当前没有打开的思维导图,或序列化失败。
create
static create(container: string | HTMLElement, options?: JsMindOptions): Promise<JsMind>创建 jsMind 实例,并将其视图附加到容器上。
返回值: 一个 Promise,解析为新实例。此时尚未打开思维导图;请再用 JmMind 调用 JsMind.open 来显示一张图。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
container | string | HTMLElement | 容器元素,或文档中某个元素的 id。 |
options (可选) | JsMindOptions | 该实例的配置。省略的字段使用库的默认值。 |