🔧 Constants

• VIEW_KEY
• theme

⚙️ VIEW_KEY

Constant	Type
VIEW_KEY	"__Y_MINDMAP_VIEW__"

🔗 Source

⚙️ theme

Constant	Type
theme	Theme

🔗 Source

🏭 Schema

🔗 Source

Methods

• registerNode
• parseNode
• createNode

⚙️ registerNode

Method	Type
registerNode	(node: NodeType<NodeSpec<any>>) => void

🔗 Source

⚙️ parseNode

parseNode from xmlElement

Method	Type
parseNode	(xml: YXmlElement<{ [key: string]: string; }> or YXmlText) => Node<any> or null

🔗 Source

⚙️ createNode

createNode

Method	Type
createNode	(type: string or NodeType<NodeSpec<any>>, attrs: IAttrs, content: INodeContent) => Node<any>

🔗 Source

🏭 NodeType

🔗 Source

Methods

• setSchema
• create
• parse
• createNode

⚙️ setSchema

Method	Type
setSchema	(schema: Schema) => void

🔗 Source

⚙️ create

Method	Type
create	(attrs?: IAttrs, content?: INodeContent, initYFragment?: YXmlElement<{ [key: string]: string; }> or YXmlText or null) => Node<any>

🔗 Source

⚙️ parse

Method	Type
parse	(xml: YXmlElement<{ [key: string]: string; }> or YXmlText) => Node<any>

🔗 Source

⚙️ createNode

Method	Type
createNode	<T extends NodeSpec<any>>(options: { name: string; } and T) => NodeType<T>

🔗 Source

🏭 Node

一个基础的node 作为定义转为yjs的代理

🔗 Source

Methods

• appendChild
• removeChild

⚙️ appendChild

Method	Type
appendChild	(node: Node<any>, reference?: Node<any> or undefined) => void

🔗 Source

⚙️ removeChild

Method	Type
removeChild	(node: Node<any>) => void

🔗 Source

🏭 View

🔗 Source

Methods

• pointFromPos
• destroy
• nodeAt

⚙️ pointFromPos

Method	Type
pointFromPos	(pos: number, preferBefore: boolean) => { object: UI or null; offset: number; }

🔗 Source

⚙️ destroy

Method	Type
destroy	() => void

🔗 Source

⚙️ nodeAt

Method	Type
nodeAt	(node: Node<any>) => View<UI> or undefined

🔗 Source

🏭 TextView

🔗 Source

Methods

• pointFromPos

⚙️ pointFromPos

Method	Type
pointFromPos	(pos: number) => { object: Text or null; offset: number; }

🔗 Source

🏭 NodeView

🔗 Source

Methods

• createChildView
• removeChildView
• getMatrix

⚙️ createChildView

Method	Type
createChildView	(yFragment: YXmlElement<{ [key: string]: string; }> or YXmlText, index?: number) => void

🔗 Source

⚙️ removeChildView

移除子节点

Method	Type
removeChildView	(index: number, size: number) => void

🔗 Source

⚙️ getMatrix

Method	Type
getMatrix	(inner?: boolean or undefined) => Matrix

🔗 Source

🏭 State

🔗 Source

Methods

• create

⚙️ create

Method	Type
create	(data: Doc or Uint8Array or undefined, config: Omit<StateConfig, "doc" or "undoManager">) => State

🔗 Source

🏭 BoardView

🔗 Source

Methods

• setTheme
• toDataUrl
• toSvg
• destroy
• create

⚙️ setTheme

Method	Type
setTheme	(theme: Theme) => void

🔗 Source

⚙️ toDataUrl

Method	Type
toDataUrl	(type?: "jpg" or "png" or "webp", quality?: number or undefined) => string or Promise<string>

🔗 Source

⚙️ toSvg

转为svg的方法

Method	Type
toSvg	() => string or Promise<any>

🔗 Source

⚙️ destroy

Method	Type
destroy	() => void

🔗 Source

⚙️ create

Method	Type
create	(state: State, theme: Theme, options?: ViewOptions or undefined) => BoardView

🔗 Source

🍹 Interfaces

• NodeSpec
• ISchemaSpec
• StateConfig

⚙️ NodeSpec

Property	Type	Description
content	string or undefined
group	string or undefined
attrs	{ [key in keyof K]: IAttrSpec; } or undefined
selectable	boolean or undefined
draggable	boolean or undefined
toCanvas	((node: Node<K>, context: NodeToCanvasContext) => UI) or undefined

⚙️ ISchemaSpec

Property	Type	Description
nodes	{ [key: string]: NodeType<NodeSpec<any>>; }
topNodeType	NodeType<NodeSpec<any>>

⚙️ StateConfig

Property	Type	Description
schema	Schema
doc	Doc
undoManager	UndoManager
plugins	unknown[] or undefined
selected	Node<any>[] or undefined
pluginState	Record<string, any> or undefined

🍸 Types

• NodeToCanvasContext
• INodeContent
• ViewOptions

⚙️ NodeToCanvasContext

Type	Type
NodeToCanvasContext	`{

theme: Theme;
render: Leafer;

}` |

🔗 Source

⚙️ INodeContent

Type	Type
INodeContent	Array<XmlElement or XmlText or Node> or XmlElement or XmlText or string or null

🔗 Source

⚙️ ViewOptions

Type	Type
ViewOptions	`{

width?: number,
height?: number,
debug?: boolean,
container?: any

}` |

🔗 Source