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?): Tree
Parameters
- Optional initialRoot: ElementNode
Returns Tree
- Defined in document/json/tree.ts:209

Properties

`Private` `Optional` context

context?: ChangeContext<Indexable>

`Private` `Optional` initialRoot

initialRoot?: ElementNode

`Private` `Optional` tree

tree?: CRDTTree

Methods

buildRoot

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

edit

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

editBulk

editBulk(fromIdx, toIdx, contents, splitLevel?): 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:608

editBulkByPath

editBulkByPath(fromPath, toPath, contents, splitLevel?): 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:541

editByPath

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

`Private` editInternal

editInternal(fromPos, toPos, contents, splitLevel?): boolean
Parameters
- fromPos: CRDTTreePos
- toPos: CRDTTreePos
- contents: TreeNode[]
- splitLevel: number = 0
Returns boolean
- Defined in document/json/tree.ts:432

getID

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

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

getIndexTree

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

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

getNodeSize

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

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

getRootTreeNode

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

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

getSize

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

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

indexRangeToPosRange

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

indexToPath

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

initialize

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

pathRangeToPosRange

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

pathToIndex

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

posRangeToIndexRange

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

posRangeToPathRange

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

removeStyle

removeStyle(fromIdx, toIdx, attributesToRemove): 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:387

style

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

styleByPath

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

toJSForTest

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

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

toJSInfoForTest

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

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

toJSON

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

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

toXML

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

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