Skip to content

JmMind ​

预览版本

jsMind V2 的编程 API 目前是预览版本,之后还会更新。请随时查阅本文档,以了解当前的接口。

思维导图的数据模型。用 new jsMind.Mind() 创建,再交给 JsMind.open。

本页由 TypeDoc 根据已发布的类型声明 dist/jsmind.d.ts 生成。

JmMind ​

类

包含节点和边的思维导图。

构造函数 ​

ts
constructor(metadata?: Partial<MindMetadata>, options?: Partial<MindOptions>)

创建一张新的思维导图。

参数

名称类型说明
metadata (可选)Partial<MindMetadata>思维导图的元数据。
options (可选)Partial<MindOptions>思维导图的配置选项。

meta ​

ts
meta: MindMetadata

思维导图的元数据。

observerManager ​

ts
observerManager: JmObserverManager<JmMind>

该思维导图的观察者管理器。

options ​

ts
options: MindOptions

思维导图的配置选项。

style ​

ts
style?: JmStyle

思维导图的样式声明。

说明

该导图继承自 style.theme(默认为 "default"),并覆盖声明中列出的其余项。解析与深合并发生在渲染时的 resolveJmStyle,而不是这里——这个字段只保存文件里写了什么。

root ​

ts
get root(): JmNode

获取根节点。

返回值: 根节点。

addChildNode ​

ts
addChildNode(content: unknown, parentId: string): JmNode

在某个父节点下添加一个子节点。字符串会作为文本内容存储;若传入 JmNodeContent 则原样使用。

返回值: 创建出的节点。

异常

  • JsMindError 如果缺少 parentId、缺少 content,或 content 不是字符串或 JmNodeContent。

参数

名称类型说明
contentunknown文本,或一个 JmNodeContent 对象。
parentIdstring父节点 ID。

addEdge ​

ts
addEdge(sourceNodeId: string, targetNodeId: string, type: "link", options?: EdgeCreationOptions): JmEdge

在两个节点之间添加一条边。

返回值: 创建出的边。

异常

  • JsMindError 如果源节点或目标节点不存在。

参数

名称类型说明
sourceNodeIdstring源节点 ID。
targetNodeIdstring目标节点 ID。
type"link"边的类型。
options (可选)EdgeCreationOptions可选的边创建选项。

addNode ​

ts
addNode(content: JmNodeContent, destOptions: NodeDestinationOptions, nodeOptions?: NodeCreationOptions): JmNode

在指定位置向思维导图添加一个新节点。

返回值: 创建出的节点。

异常

  • JsMindError 如果缺少 destOptions.parentId。

参数

名称类型说明
contentJmNodeContent新节点的内容。
destOptionsNodeDestinationOptions目标位置选项(必填)。
nodeOptions (可选)NodeCreationOptions可选的节点创建选项。

findNodeById ​

ts
findNodeById(nodeId: string): JmNode | null

按给定 ID 查找思维导图中的节点。

返回值: 如果存在则返回对应节点,否则返回 null。

参数

名称类型说明
nodeIdstring给定的节点 ID。

getEdges ​

ts
getEdges(nodeId: string, type?: "link" | null): JmEdge[]

获取与某个节点相关的全部边。

返回值: 涉及该节点的边的数组。

参数

名称类型说明
nodeIdstring节点 ID。
type (可选)"link" | null可选的边类型过滤。

moveNode ​

ts
moveNode(nodeId: string, destOptions: NodeDestinationOptions): JmNode

将节点移动到新的父节点和位置。

返回值: 被移动的节点。

异常

  • JsMindError 如果缺少 destOptions、找不到节点,或移动操作无效。

参数

名称类型说明
nodeIdstring要移动的节点 ID。
destOptionsNodeDestinationOptions目标位置选项。

removeEdge ​

ts
removeEdge(edgeId: string): boolean

按 ID 删除一条边。

返回值: 如果边被删除则为 true,如果未找到则为 false。

参数

名称类型说明
edgeIdstring要删除的边 ID。

removeNode ​

ts
removeNode(nodeId: string): void

删除一个节点及其全部后代。

异常

  • JsMindError 如果试图删除根节点。

参数

名称类型说明
nodeIdstring要删除的节点 ID。

MindMetadata ​

接口

思维导图的元数据。

属性

名称类型说明
authorstring思维导图的作者。
namestring思维导图的名称。
versionstring思维导图的版本。

MindOptions ​

接口

思维导图的配置选项。

属性

名称类型说明
rootNodeIdstring

JmObserver ​

接口

观察者模式的接口。

属性

名称类型说明
updateunknown当被观察对象的状态发生变化时会调用此方法。

JmObserverManager ​

类

被观察对象的观察者管理器。

构造函数 ​

ts
constructor(observedObject: T)

为被观察对象创建观察者管理器。

参数

名称类型说明
observedObjectT要观察的对象。

observedObject ​

ts
observedObject: T

被观察的对象。

addObserver ​

ts
addObserver(observer: JmObserver<T>): void

向被观察对象添加一个观察者。

异常

  • JsMindError 如果观察者不是有效的 JmObserver 实例。

参数

名称类型说明
observerJmObserver<T>一个包含 update(observedObject, event) 方法的对象。

clearObservers ​

ts
clearObservers(): void

移除该对象上的全部观察者。

notifyObservers ​

ts
notifyObservers(event: unknown): Promise<void>

将事件通知给所有观察者。

说明

这是一个异步方法。每个观察者在各自的异步操作中收到通知。

参数

名称类型说明
eventunknown事件由不同的被观察对象定义,表示变更的具体信息。

removeObserver ​

ts
removeObserver(observer: JmObserver<T>): void

移除先前通过 addObserver 方法添加的观察者。

参数

名称类型说明
observerJmObserver<T>要移除的观察者。

本文档由 AI 协助生成 / This documentation was prepared with AI assistance