Trilium Frontend API
    Preparing search index...

    Interface ModelTreeWalkerOptions

    The configuration of TreeWalker.

    All parameters are optional, but you have to specify either boundaries or startPosition.

    interface ModelTreeWalkerOptions {
        boundaries?: ModelRange;
        direction?: ModelTreeWalkerDirection;
        ignoreElementEnd?: boolean;
        shallow?: boolean;
        singleCharacters?: boolean;
        startPosition?: ModelPosition;
    }
    Index

    Properties

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

    Properties

    boundaries?: ModelRange

    Range to define boundaries of the iterator.

    direction?: ModelTreeWalkerDirection

    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/model/element~ModelElement 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 consecutive characters with the same attributes should be returned one by one as multiple module:engine/model/textproxy~ModelTextProxy (true) objects or as one module:engine/model/textproxy~ModelTextProxy (false).

    startPosition?: ModelPosition

    Starting position.

    Settings

    Member Visibility

    On This Page

    Properties