CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

TreeWalker (engine/view)

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

class
See source

Position iterator class. It allows to iterate forward and backward over the document.

Filtering

Properties

  • readonly

    boundaries : null | Range

    See source

    Iterator boundaries.

    When the iterator is walking 'forward' on the end of boundary or is walking 'backward' on the start of boundary, then { done: true } is returned.

    If boundaries are not defined they are set before first and after last child of the root node.

  • readonly

    direction : TreeWalkerDirection

    See source

    Walking direction. Defaults 'forward'.

  • readonly

    ignoreElementEnd : boolean

    See source

    Flag indicating whether iterator should ignore elementEnd tags. If set to true, walker will not return a parent node of the start position. Each Element will be returned once. When set to false each element might be returned twice: for 'elementStart' and 'elementEnd'.

  • readonly

    position : Position

    See source

    Iterator position. If start position is not defined then position depends on direction. If direction is 'forward' position starts form the beginning, when direction is 'backward' position starts from the end.

  • readonly

    shallow : boolean

    See source

    Flag indicating whether iterator should enter elements or not. If the iterator is shallow child nodes of any iterated node will not be returned along with elementEnd tag.

  • readonly

    singleCharacters : boolean

    See source

    Flag indicating whether all characters from Text should be returned as one Text or one by one as TextProxy.

  • private readonly

    _boundaryEndParent : null | Node | DocumentFragment

    See source

    End boundary parent.

  • private readonly

    _boundaryStartParent : null | Node | DocumentFragment

    See source

    Start boundary parent.

  • private

    _position : Position

    See source

    Iterator position. If start position is not defined then position depends on direction. If direction is 'forward' position starts form the beginning, when direction is 'backward' position starts from the end.

Methods

  • constructor( options )

    See source

    Creates a range iterator. All parameters are optional, but you have to specify either boundaries or startPosition.

    Parameters

    options : TreeWalkerOptions

    Object with configuration.

    Defaults to {}

  • Symbol.iterator() → IterableIterator<TreeWalkerValue>

    See source

    Iterable interface.

    Returns

    IterableIterator<TreeWalkerValue>

  • jumpTo( position ) → void

    See source

    Moves tree walker position to provided position. Tree walker will continue traversing from that position.

    Note: in contrary to skip, this method does not iterate over the nodes along the way. It simply sets the current tree walker position to a new one. From the performance standpoint, it is better to use jumpTo rather than skip.

    If the provided position is before the start boundary, the position will be set to the start boundary. If the provided position is after the end boundary, the position will be set to the end boundary. This is done to prevent the treewalker from traversing outside the boundaries.

    Parameters

    position : Position

    Position to jump to.

    Returns

    void

  • next() → IteratorResult<TreeWalkerValue, undefined>

    See source

    Gets the next tree walker's value.

    Returns

    IteratorResult<TreeWalkerValue, undefined>

    Object implementing iterator interface, returning information about taken step.

  • skip( skip ) → void

    See source

    Moves position in the direction skipping values as long as the callback function returns true.

    For example:

    walker.skip( value => value.type == 'text' ); // <p>{}foo</p> -> <p>foo[]</p>
walker.skip( value => true ); // Move the position to the end: <p>{}foo</p> -> <p>foo</p>[]
walker.skip( value => false ); // Do not move the position.

    Parameters

    skip : ( value: TreeWalkerValue ) => boolean

    Callback function. Gets TreeWalkerValue and should return true if the value should be skipped or false if not.

    Returns

    void

  • private

    _formatReturnValue( type, item, previousPosition, nextPosition, [ length ] ) → IteratorYieldResult<TreeWalkerValue>

    See source

    Format returned data and adjust previousPosition and nextPosition if reach the bound of the Text.

    Parameters

    type : TreeWalkerValueType

    Type of step.

    item : Item

    Item between old and new position.

    previousPosition : Position

    Previous position of iterator.

    nextPosition : Position

    Next position of iterator.

    [ length ] : number

    Length of the item.

    Returns

    IteratorYieldResult<TreeWalkerValue>

  • private

    _next() → IteratorResult<TreeWalkerValue, undefined>

    See source

    Makes a step forward in view. Moves the position to the next position and returns the encountered value.

    Returns

    IteratorResult<TreeWalkerValue, undefined>

  • private

    _previous() → IteratorResult<TreeWalkerValue, undefined>

    See source

    Makes a step backward in view. Moves the position to the previous position and returns the encountered value.

    Returns

    IteratorResult<TreeWalkerValue, undefined>