Class Tree

Tree is a CRDT-based tree structure that is used to represent the document tree of text-based editor such as ProseMirror.

Constructors

constructor

new Tree(initialRoot?: ElementNode): Tree
Parameters
- OptionalinitialRoot: ElementNode
Returns Tree
- Defined in document/json/tree.ts:343

Methods

buildRoot

buildRoot(context: ChangeContext): CRDTTreeNode
buildRoot builds the root of this tree with the given initial root which set by the user.
Parameters
- context: ChangeContext
Returns CRDTTreeNode
- Defined in document/json/tree.ts:366

edit

edit(
    fromIdx: number,
    toIdx: number,
    content?: TreeNode,
    splitLevel?: number,
): boolean
edit edits this tree with the given nodes.
Parameters
- fromIdx: number
- toIdx: number
- Optionalcontent: TreeNode
- splitLevel: number = 0
Returns boolean
- Defined in document/json/tree.ts:776

editBulk

editBulk(
    fromIdx: number,
    toIdx: number,
    contents: TreeNode[],
    splitLevel?: number,
): boolean
editBulk edits this tree with the given nodes.
Parameters
- fromIdx: number
- toIdx: number
- contents: TreeNode[]
- splitLevel: number = 0
Returns boolean
- Defined in document/json/tree.ts:809

editBulkByPath

editBulkByPath(
    fromPath: number[],
    toPath: number[],
    contents: TreeNode[],
    splitLevel?: number,
): boolean
editBulkByPath edits this tree with the given node and path.
Parameters
- fromPath: number[]
- toPath: number[]
- contents: TreeNode[]
- splitLevel: number = 0
Returns boolean
- Defined in document/json/tree.ts:742

editByPath

editByPath(
    fromPath: number[],
    toPath: number[],
    content?: TreeNode,
    splitLevel?: number,
): boolean
editByPath edits this tree with the given node and path.
Parameters
- fromPath: number[]
- toPath: number[]
- Optionalcontent: TreeNode
- splitLevel: number = 0
Returns boolean
- Defined in document/json/tree.ts:703

getID

getID(): TimeTicket
getID returns the ID of this tree.

Returns TimeTicket
- Defined in document/json/tree.ts:358

getIndexTree

getIndexTree(): IndexTree<CRDTTreeNode>
getIndexTree returns the index tree of this tree.

Returns IndexTree<CRDTTreeNode>
- Defined in document/json/tree.ts:418

getNodeSize

getNodeSize(): number
getNodeSize returns the node size of this tree.

Returns number
- Defined in document/json/tree.ts:404

getRootTreeNode

getRootTreeNode(): TreeNode
getRootTreeNode returns TreeNode of this tree.

Returns TreeNode
- Defined in document/json/tree.ts:893

getSize

getSize(): number
getSize returns the size of this tree.

Returns number
- Defined in document/json/tree.ts:390

indexRangeToPosRange

indexRangeToPosRange(range: [number, number]): TreePosStructRange
indexRangeToPosRange converts the index range into the position range.
Parameters
- range: [number, number]
Returns TreePosStructRange
- Defined in document/json/tree.ts:956

indexToPath

indexToPath(index: number): number[]
indexToPath returns the path of the given index.
Parameters
- index: number
Returns number[]
- Defined in document/json/tree.ts:907

initialize

initialize(context: ChangeContext, tree: CRDTTree): void
initialize initialize this tree with context and internal tree.
Parameters
- context: ChangeContext
- tree: CRDTTree
Returns void
- Defined in document/json/tree.ts:350

mergeByPath

mergeByPath(path: number[]): void
mergeByPath merges the tree by the given path.
Parameters
- path: number[]
Returns void
- Defined in document/json/tree.ts:462

pathRangeToPosRange

pathRangeToPosRange(range: [number[], number[]]): TreePosStructRange
pathRangeToPosRange converts the path range into the position range.
Parameters
- range: [number[], number[]]
Returns TreePosStructRange
- Defined in document/json/tree.ts:935

pathToIndex

pathToIndex(path: number[]): number
pathToIndex returns the index of given path.
Parameters
- path: number[]
Returns number
- Defined in document/json/tree.ts:921

posRangeToIndexRange

posRangeToIndexRange(range: TreePosStructRange): [number, number]
posRangeToIndexRange converts the position range into the index range.
Parameters
- range: TreePosStructRange
Returns [number, number]
- Defined in document/json/tree.ts:970

posRangeToPathRange

posRangeToPathRange(range: TreePosStructRange): [number[], number[]]
posRangeToPathRange converts the position range into the path range.
Parameters
- range: TreePosStructRange
Returns [number[], number[]]
- Defined in document/json/tree.ts:989

removeStyle

removeStyle(fromIdx: number, toIdx: number, attributesToRemove: string[]): void
removeStyle removes the attributes to the elements of the given range.
Parameters
- fromIdx: number
- toIdx: number
- attributesToRemove: string[]
Returns void
- Defined in document/json/tree.ts:586

splitByPath

splitByPath(path: number[]): void
splitByPath splits the tree by the given path.
Parameters
- path: number[]
Returns void
- Defined in document/json/tree.ts:432

style

style(fromIdx: number, toIdx: number, attributes: { [key: string]: any }): void
style sets the attributes to the elements of the given range.
Parameters
- fromIdx: number
- toIdx: number
- attributes: { [key: string]: any }
Returns void
- Defined in document/json/tree.ts:540

styleByPath

styleByPath(path: number[], attributes: { [key: string]: any }): void
styleByPath sets the attributes to the elements of the given path.
Parameters
- path: number[]
- attributes: { [key: string]: any }
Returns void
- Defined in document/json/tree.ts:500

toJSForTest

toJSForTest(): Devtools.JSONElement
toJSForTest returns value with meta data for testing.

Returns Devtools.JSONElement
- Defined in document/json/tree.ts:865

toJSInfoForTest

toJSInfoForTest(): TreeNodeInfo
toJSInfoForTest returns detailed TreeNode information for use in Devtools.

Returns TreeNodeInfo
- Defined in document/json/tree.ts:879

toJSON

toJSON(): string
toJSON returns the JSON string of this tree.

Returns string
- Defined in document/json/tree.ts:851

toXML

toXML(): string
toXML returns the XML string of this tree.

Returns string
- Defined in document/json/tree.ts:837