Report an issue
Typedef

TreeWalkerValue (engine/view)

@ckeditor/ckeditor5-engine/src/view/treewalker

typedef
Object

Object returned by TreeWalker when traversing tree view.

Filtering

Properties

  • Item between old and new positions of TreeWalker.

  • length : Number

    Length of the item. For 'elementStart' it is 1. For 'text' it is the length of the text. For 'elementEnd' it is undefined.

  • Next position of the iterator.

    • Forward iteration: For 'elementStart' it is the first position inside the element. For all other types it is the position after the item.
    • Backward iteration: For 'elementEnd' it is last position inside element. For all other types it is the position before the item.
    • If the position is at the beginning or at the end of the Text it is always moved from the inside of the Text to its parent just before or just after Text.
  • Previous position of the iterator.

    • Forward iteration: For 'elementEnd' it is the last position inside the element. For all other types it is the position before the item. Note that it is more efficient to use this position then calculate the position before the node using createBefore.
    • Backward iteration: For 'elementStart' it is the first position inside the element. For all other types it is the position after item.
    • If the position is at the beginning or at the end of the Text it is always moved from the inside of the Text to its parent just before or just after Text.