Interface ViewTreeWalkerValue

Object returned by module:engine/view/treewalker~ViewTreeWalker when traversing tree view.

interface ViewTreeWalkerValue {
    item: ViewItem;
    length?: number;
    nextPosition: ViewPosition;
    previousPosition: ViewPosition;
    type: ViewTreeWalkerValueType;
}

Properties

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: ViewPosition

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 module:engine/view/text~ViewText it is always moved from the inside of the text to its parent just before or just after that text.

previousPosition: ViewPosition

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 module:engine/view/text~ViewText it is always moved from the inside of the text to its parent just before or just after that text.

Type of the step made by module:engine/view/treewalker~ViewTreeWalker.