节点
预览版本
jsMind V2 的编程 API 目前是预览版本,之后还会更新。请随时查阅本文档,以了解当前的接口。
节点、节点内容,以及把子节点放在根节点左侧或右侧时使用的方向值。
本页由 TypeDoc 根据已发布的类型声明 dist/jsmind.d.ts 生成。
JmNode
类
思维导图的节点。
构造函数
constructor(id: string, content: JmNodeContent)创建一个新节点。
异常
JsMindError如果节点 ID 或内容无效。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
id | string | 节点的唯一标识符。 |
content | JmNodeContent | 节点的内容。 |
children
children: JmNode[]子节点数组。
content
content: JmNodeContent节点的内容。
data
data: Record<string, unknown>与该节点关联的附加数据。
folded
folded: boolean节点是否折叠。
id
id: string节点的唯一标识符。
parent
parent: JmNode | null父节点;如果是根节点则为 null。
side
side: JmNodeSide节点的方向。
style
style?: JmNodeStyle该节点的视觉覆盖。
说明
未设置的字段回退到主题。只保存与主题的差异,这样主题变更仍能作用于所有没有覆盖任何项的节点。
equals
equals(other: JmNode): boolean将本节点与另一个节点比较。
返回值: 如果相等则为 true,否则为 false。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
other | JmNode | 要比较的另一个节点。 |
getAllSubnodeIds
getAllSubnodeIds(): string[]递归列出全部子节点 ID。
返回值: 所有子节点及其后代的 ID 数组。
isDescendant
isDescendant(potentialAncestor: JmNode): boolean检查本节点是否为另一个节点的后代。
返回值: 如果本节点是 potentialAncestor 的后代则为 true。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
potentialAncestor | JmNode | 可能的祖先节点。 |
isRoot
isRoot(): boolean检查本节点是否为根节点(没有父节点)。
返回值: 如果本节点没有父节点则为 true。
JmNodeContent
类
思维导图节点的内容。
构造函数
constructor(type: "text", value: unknown)创建一个内容对象。
异常
Error如果内容类型无效。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
type | "text" | 内容类型。 |
value | unknown | 实际的内容值。 |
type
type: "text"内容的类型。
value
value: unknown实际的内容值。
getText
getText(): string返回该内容的文本值。
返回值: 文本值。
异常
Error如果内容不是文本类型。
hasType
hasType(type: "text"): boolean检查内容是否为指定类型。
返回值: 如果内容是指定类型则为 true。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
type | "text" | 要检查的类型。 |
isText
isText(): boolean检查内容是否为文本类型。
返回值: 如果内容是文本类型则为 true。
createText
static createText(text: string): JmNodeContent创建一个文本内容对象。
返回值: 内容对象。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
text | string | 文本内容。 |
fromObject
static fromObject(obj: { type: "text"; value: unknown }): JmNodeContent从带有 type 和 value 的对象创建内容对象。
返回值: 内容对象。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
obj | 用于创建内容的对象。 |
JmNodeContentType
枚举
节点内容类型的枚举。
成员
| 名称 | 值 | 说明 |
|---|---|---|
Text | "text" | 文本内容类型。 |
JmNodeSide
枚举
节点方向的枚举。
成员
| 名称 | 值 | 说明 |
|---|---|---|
Center | 0 | 居中方向。 |
SideA | 1 | 右侧方向。 |
SideB | -1 | 左侧方向。 |
NodeCreationOptions
接口
创建新节点时的选项。
属性
| 名称 | 类型 | 说明 |
|---|---|---|
data (可选) | Record<string, unknown> | 节点的附加数据(默认:{})。 |
folded (可选) | boolean | 节点是否折叠(默认:false)。 |
nodeId (可选) | string | 可选的自定义节点 ID。 |
side (可选) | JmNodeSide | 节点的方向(默认:null)。 |
style (可选) | JmNodeStyle | 节点的视觉覆盖(默认:无)。 |
NodeDestinationOptions
接口
用于指定节点目标位置的选项。
属性
| 名称 | 类型 | 说明 |
|---|---|---|
parentId | string | 目标父节点的 ID(必填)。 |
position (可选) | number | 在兄弟节点中的位置索引(若不提供,则添加到末尾)。 |
side (可选) | JmNodeSide | 节点的方向(若不提供,则保持当前方向)。 |