CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Typedef

TreeWalkerValue (engine/view)

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

typedef
Object
See source

Object returned by TreeWalker when traversing tree view.

Filtering

Properties

  • item : Item

    Item between the old and the new positions of the tree walker.

  • length : Number

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

  • nextPosition : Position

    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 that text.

  • previousPosition : Position

    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.
    • 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 that text.

  • type : TreeWalkerValueType