Trilium Frontend API
    Preparing search index...

    Interface ViewTreeWalkerOptions

    The configuration of ~ViewTreeWalker.

    interface ViewTreeWalkerOptions {
        boundaries?: ViewRange;
        direction?: ViewTreeWalkerDirection;
        ignoreElementEnd?: boolean;
        shallow?: boolean;
        singleCharacters?: boolean;
        startPosition?: ViewPosition;
    }
    Index

    Properties

    boundaries? direction? ignoreElementEnd? shallow? singleCharacters? startPosition?

    Properties

    boundaries?: ViewRange

    Range to define boundaries of the iterator.

    direction?: ViewTreeWalkerDirection

    Walking direction.

    'forward'
    ignoreElementEnd?: boolean

    Flag indicating whether iterator should ignore elementEnd tags. If the option is true walker will not return a parent node of start position. If this option is true each module:engine/view/element~ViewElement will be returned once, while if the option is false they might be returned twice: for 'elementStart' and 'elementEnd'.

    shallow?: boolean

    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.

    singleCharacters?: boolean

    Flag indicating whether all characters from module:engine/view/text~ViewText should be returned as one module:engine/view/text~ViewText (false) or one by one as module:engine/view/textproxy~ViewTextProxy (true).

    startPosition?: ViewPosition

    Starting position.

    Settings

    Member Visibility

    On This Page

    Properties