CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Typedef

TreeWalkerValue (engine/model)

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

typedef
Object
See source

Object returned by TreeWalker when traversing tree model.

Filtering

Properties

  • item : Item

    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.

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

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

  • type : TreeWalkerValueType