Skip to content

节点 ​

预览版本

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

节点、节点内容,以及把子节点放在根节点左侧或右侧时使用的方向值。

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

JmNode ​

类

思维导图的节点。

构造函数 ​

ts
constructor(id: string, content: JmNodeContent)

创建一个新节点。

异常

  • JsMindError 如果节点 ID 或内容无效。

参数

名称类型说明
idstring节点的唯一标识符。
contentJmNodeContent节点的内容。

children ​

ts
children: JmNode[]

子节点数组。

content ​

ts
content: JmNodeContent

节点的内容。

data ​

ts
data: Record<string, unknown>

与该节点关联的附加数据。

folded ​

ts
folded: boolean

节点是否折叠。

id ​

ts
id: string

节点的唯一标识符。

parent ​

ts
parent: JmNode | null

父节点;如果是根节点则为 null。

side ​

ts
side: JmNodeSide

节点的方向。

style ​

ts
style?: JmNodeStyle

该节点的视觉覆盖。

说明

未设置的字段回退到主题。只保存与主题的差异,这样主题变更仍能作用于所有没有覆盖任何项的节点。

equals ​

ts
equals(other: JmNode): boolean

将本节点与另一个节点比较。

返回值: 如果相等则为 true,否则为 false。

参数

名称类型说明
otherJmNode要比较的另一个节点。

getAllSubnodeIds ​

ts
getAllSubnodeIds(): string[]

递归列出全部子节点 ID。

返回值: 所有子节点及其后代的 ID 数组。

isDescendant ​

ts
isDescendant(potentialAncestor: JmNode): boolean

检查本节点是否为另一个节点的后代。

返回值: 如果本节点是 potentialAncestor 的后代则为 true。

参数

名称类型说明
potentialAncestorJmNode可能的祖先节点。

isRoot ​

ts
isRoot(): boolean

检查本节点是否为根节点(没有父节点)。

返回值: 如果本节点没有父节点则为 true。

JmNodeContent ​

类

思维导图节点的内容。

构造函数 ​

ts
constructor(type: "text", value: unknown)

创建一个内容对象。

异常

  • Error 如果内容类型无效。

参数

名称类型说明
type"text"内容类型。
valueunknown实际的内容值。

type ​

ts
type: "text"

内容的类型。

value ​

ts
value: unknown

实际的内容值。

getText ​

ts
getText(): string

返回该内容的文本值。

返回值: 文本值。

异常

  • Error 如果内容不是文本类型。

hasType ​

ts
hasType(type: "text"): boolean

检查内容是否为指定类型。

返回值: 如果内容是指定类型则为 true。

参数

名称类型说明
type"text"要检查的类型。

isText ​

ts
isText(): boolean

检查内容是否为文本类型。

返回值: 如果内容是文本类型则为 true。

createText ​

ts
static createText(text: string): JmNodeContent

创建一个文本内容对象。

返回值: 内容对象。

参数

名称类型说明
textstring文本内容。

fromObject ​

ts
static fromObject(obj: { type: "text"; value: unknown }): JmNodeContent

从带有 type 和 value 的对象创建内容对象。

返回值: 内容对象。

参数

名称类型说明
obj用于创建内容的对象。

JmNodeContentType ​

枚举

节点内容类型的枚举。

成员

名称值说明
Text"text"文本内容类型。

JmNodeSide ​

枚举

节点方向的枚举。

成员

名称值说明
Center0居中方向。
SideA1右侧方向。
SideB-1左侧方向。

NodeCreationOptions ​

接口

创建新节点时的选项。

属性

名称类型说明
data (可选)Record<string, unknown>节点的附加数据(默认:{})。
folded (可选)boolean节点是否折叠(默认:false)。
nodeId (可选)string可选的自定义节点 ID。
side (可选)JmNodeSide节点的方向(默认:null)。
style (可选)JmNodeStyle节点的视觉覆盖(默认:无)。

NodeDestinationOptions ​

接口

用于指定节点目标位置的选项。

属性

名称类型说明
parentIdstring目标父节点的 ID(必填)。
position (可选)number在兄弟节点中的位置索引(若不提供,则添加到末尾)。
side (可选)JmNodeSide节点的方向(若不提供,则保持当前方向)。

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