Sign up (with export icon)

ModelTreeWalkerOptions

Api-interface icon interface

The configuration of TreeWalker.

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

Properties

  • Chevron-right icon

    boundaries : null | ModelRange | undefined

    Range to define boundaries of the iterator.

  • Chevron-right icon

    Walking direction.

    Defaults to 'forward'

  • Chevron-right icon

    ignoreElementEnd : boolean | undefined

    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 ModelElement will be returned once, while if the option is false they might be returned twice: for 'elementStart' and 'elementEnd'.

  • Chevron-right icon

    shallow : boolean | undefined

    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.

  • Chevron-right icon

    singleCharacters : boolean | undefined

    Flag indicating whether all consecutive characters with the same attributes should be returned one by one as multiple ModelTextProxy (true) objects or as one ModelTextProxy (false).

  • Chevron-right icon