JmMind
预览版本
jsMind V2 的编程 API 目前是预览版本,之后还会更新。请随时查阅本文档,以了解当前的接口。
思维导图的数据模型。用 new jsMind.Mind() 创建,再交给 JsMind.open。
本页由 TypeDoc 根据已发布的类型声明 dist/jsmind.d.ts 生成。
JmMind
类
包含节点和边的思维导图。
构造函数
constructor(metadata?: Partial<MindMetadata>, options?: Partial<MindOptions>)创建一张新的思维导图。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
metadata (可选) | Partial<MindMetadata> | 思维导图的元数据。 |
options (可选) | Partial<MindOptions> | 思维导图的配置选项。 |
meta
meta: MindMetadata思维导图的元数据。
observerManager
observerManager: JmObserverManager<JmMind>该思维导图的观察者管理器。
options
options: MindOptions思维导图的配置选项。
style
style?: JmStyle思维导图的样式声明。
说明
该导图继承自 style.theme(默认为 "default"),并覆盖声明中列出的其余项。解析与深合并发生在渲染时的 resolveJmStyle,而不是这里——这个字段只保存文件里写了什么。
root
get root(): JmNode获取根节点。
返回值: 根节点。
addChildNode
addChildNode(content: unknown, parentId: string): JmNode在某个父节点下添加一个子节点。字符串会作为文本内容存储;若传入 JmNodeContent 则原样使用。
返回值: 创建出的节点。
异常
JsMindError如果缺少parentId、缺少content,或content不是字符串或 JmNodeContent。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
content | unknown | 文本,或一个 JmNodeContent 对象。 |
parentId | string | 父节点 ID。 |
addEdge
addEdge(sourceNodeId: string, targetNodeId: string, type: "link", options?: EdgeCreationOptions): JmEdge在两个节点之间添加一条边。
返回值: 创建出的边。
异常
JsMindError如果源节点或目标节点不存在。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
sourceNodeId | string | 源节点 ID。 |
targetNodeId | string | 目标节点 ID。 |
type | "link" | 边的类型。 |
options (可选) | EdgeCreationOptions | 可选的边创建选项。 |
addNode
addNode(content: JmNodeContent, destOptions: NodeDestinationOptions, nodeOptions?: NodeCreationOptions): JmNode在指定位置向思维导图添加一个新节点。
返回值: 创建出的节点。
异常
JsMindError如果缺少 destOptions.parentId。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
content | JmNodeContent | 新节点的内容。 |
destOptions | NodeDestinationOptions | 目标位置选项(必填)。 |
nodeOptions (可选) | NodeCreationOptions | 可选的节点创建选项。 |
findNodeById
findNodeById(nodeId: string): JmNode | null按给定 ID 查找思维导图中的节点。
返回值: 如果存在则返回对应节点,否则返回 null。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
nodeId | string | 给定的节点 ID。 |
getEdges
getEdges(nodeId: string, type?: "link" | null): JmEdge[]获取与某个节点相关的全部边。
返回值: 涉及该节点的边的数组。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
nodeId | string | 节点 ID。 |
type (可选) | "link" | null | 可选的边类型过滤。 |
moveNode
moveNode(nodeId: string, destOptions: NodeDestinationOptions): JmNode将节点移动到新的父节点和位置。
返回值: 被移动的节点。
异常
JsMindError如果缺少 destOptions、找不到节点,或移动操作无效。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
nodeId | string | 要移动的节点 ID。 |
destOptions | NodeDestinationOptions | 目标位置选项。 |
removeEdge
removeEdge(edgeId: string): boolean按 ID 删除一条边。
返回值: 如果边被删除则为 true,如果未找到则为 false。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
edgeId | string | 要删除的边 ID。 |
removeNode
removeNode(nodeId: string): void删除一个节点及其全部后代。
异常
JsMindError如果试图删除根节点。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
nodeId | string | 要删除的节点 ID。 |
MindMetadata
接口
思维导图的元数据。
属性
| 名称 | 类型 | 说明 |
|---|---|---|
author | string | 思维导图的作者。 |
name | string | 思维导图的名称。 |
version | string | 思维导图的版本。 |
MindOptions
接口
思维导图的配置选项。
属性
| 名称 | 类型 | 说明 |
|---|---|---|
rootNodeId | string |
JmObserver
接口
观察者模式的接口。
属性
| 名称 | 类型 | 说明 |
|---|---|---|
update | unknown | 当被观察对象的状态发生变化时会调用此方法。 |
JmObserverManager
类
被观察对象的观察者管理器。
构造函数
constructor(observedObject: T)为被观察对象创建观察者管理器。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
observedObject | T | 要观察的对象。 |
observedObject
observedObject: T被观察的对象。
addObserver
addObserver(observer: JmObserver<T>): void向被观察对象添加一个观察者。
异常
JsMindError如果观察者不是有效的 JmObserver 实例。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
observer | JmObserver<T> | 一个包含 update(observedObject, event) 方法的对象。 |
clearObservers
clearObservers(): void移除该对象上的全部观察者。
notifyObservers
notifyObservers(event: unknown): Promise<void>将事件通知给所有观察者。
说明
这是一个异步方法。每个观察者在各自的异步操作中收到通知。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
event | unknown | 事件由不同的被观察对象定义,表示变更的具体信息。 |
removeObserver
removeObserver(observer: JmObserver<T>): void移除先前通过 addObserver 方法添加的观察者。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
observer | JmObserver<T> | 要移除的观察者。 |