🧰 Functions

• string2Yjs
• yjs2string
• getDefaultData
• isMac
• isWin
• getPadding
• keydownHandler
• registerTextEditor

⚙️ string2Yjs

Function	Type
string2Yjs	(xmlString: string) => Uint8Array

🔗 Source

⚙️ yjs2string

Function	Type
yjs2string	(doc: Doc) => string

🔗 Source

⚙️ getDefaultData

Function	Type
getDefaultData	() => string

🔗 Source

⚙️ isMac

判断是否是mac环境

Function	Type
isMac	() => boolean

🔗 Source

⚙️ isWin

Function	Type
isWin	() => boolean

🔗 Source

⚙️ getPadding

Function	Type
getPadding	(value: IFourNumber) => [number, number, number, number]

🔗 Source

⚙️ keydownHandler

Function	Type
keydownHandler	(bindings: { [key: string]: Command; }, board: Board<any>) => (event: IKeyEvent) => boolean

🔗 Source

⚙️ registerTextEditor

普通的文本编辑器

Function	Type
registerTextEditor	(editor: Editor, leafer: ILeafer) => void

🔗 Source

🔧 Constants

• VIEW_KEY
• theme
• attrList

⚙️ VIEW_KEY

Constant	Type
VIEW_KEY	"__Y_MINDMAP_VIEW__"

🔗 Source

⚙️ theme

Constant	Type
theme	Theme

🔗 Source

⚙️ attrList

Constant	Type
attrList	EditorAttrs[]

🔗 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

🏭 State

🔗 Source

Methods

• create

⚙️ create

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

🔗 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

🏭 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

🏭 CommandManager

🔗 Source

Methods

• registerCommands

⚙️ registerCommands

Method	Type
registerCommands	(rawCommands: RawCommands) => void

🔗 Source

🏭 Extension

🔗 Source

Methods

• create

⚙️ create

Method	Type
create	(options: IExtensionOptions, boardOptions: Record<string, any>) => Extension<Record<string, any>, Record<string, any>>

🔗 Source

🏭 ExtensionManager

🔗 Source

Methods

• invokeUpdate
• invokeCreate
• invokeDestroy
• registerExtension

⚙️ invokeUpdate

Method	Type
invokeUpdate	() => void

🔗 Source

⚙️ invokeCreate

Method	Type
invokeCreate	() => void

🔗 Source

⚙️ invokeDestroy

Method	Type
invokeDestroy	() => void

🔗 Source

⚙️ registerExtension

Method	Type
registerExtension	(extensions: Record<string, IExtensionConfig<any, any>>, defaultOptions: Record<string, any>) => void

🔗 Source

🏭 Board

🔗 Source

Methods

• init
• undo
• redo
• toDataUrl
• toSvg
• getData
• toString
• destroy

⚙️ init

Method	Type
init	(data?: string or Doc or Uint8Array or undefined) => void

🔗 Source

⚙️ undo

Method	Type
undo	() => void

🔗 Source

⚙️ redo

Method	Type
redo	() => 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> or null

🔗 Source

⚙️ getData

Method	Type
getData	() => string

🔗 Source

⚙️ toString

Method	Type
toString	() => string

🔗 Source

⚙️ destroy

销毁的办法

Method	Type
destroy	() => void

🔗 Source

🏭 TextEditor

🔗 Source

Methods

• calculateDomStyle
• destroy

⚙️ calculateDomStyle

Method	Type
calculateDomStyle	() => void

🔗 Source

⚙️ destroy

Method	Type
destroy	() => void

🔗 Source

🏭 Mindmap

网页版的mindmap 支持事件上的缩放，增加事件回调 同时如果获取了canvas的dom，就需要初始化一个quill editor

🔗 Source

Methods

• init
• initEditor
• setEditable
• destroy

⚙️ init

Method	Type
init	(data: any) => void

🔗 Source

⚙️ initEditor

Method	Type
initEditor	() => void

🔗 Source

⚙️ setEditable

Method	Type
setEditable	(value?: boolean) => void

🔗 Source

⚙️ destroy

销毁的办法

Method	Type
destroy	() => void

🔗 Source

🍹 Interfaces

• NodeSpec
• ISchemaSpec
• StateConfig
• IExtensionConfig

⚙️ 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

⚙️ IExtensionConfig

Property	Type	Description
addCommands	((this: Extension<IOptions, IStorage>, extension: Extension<IOptions, IStorage>) => RawCommands) or undefined
addNodes	((this: Board<any>) => Record<string, NodeType<NodeSpec<any>>>) or undefined
addOptions	((this: Extension<IOptions, IStorage>) => IOptions) or undefined
addStorage	((this: Extension<IOptions, IStorage>) => IStorage) or undefined
addKeymap	((this: Extension<IOptions, IStorage>) => Record<string, Command>) or undefined
onBeforeCreate	((this: Extension<IOptions, IStorage>, board: Board<any>) => void) or undefined
onCreate	((this: Extension<IOptions, IStorage>, board: Board<any>) => void) or undefined
onDestroy	((this: Extension<IOptions, IStorage>, board: Board<any>) => void) or undefined
onUpdate	((this: Extension<IOptions, IStorage>, board: Board<any>) => void) or undefined

🍸 Types

• NodeToCanvasContext
• INodeContent
• ViewOptions
• IExtensionOptions
• Options

⚙️ 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

⚙️ IExtensionOptions

Type	Type
IExtensionOptions	`IExtensionConfig and {

name: string,
board: Board

}` |

🔗 Source

⚙️ Options

Type	Type
Options	`{

data?: string or Uint8Array;
width?: number;
height?: number;
theme?: string;
themeList?: { [key: string]: Theme };
options?: Record<string, any>;
extensions?: Record<string, IExtensionConfig>
container?: any

} and { schema?: Schema; debug?: boolean; }` |

🔗 Source