ModelTreeWalkerOptions
The configuration of TreeWalker.
All parameters are optional, but you have to specify either boundaries
or startPosition
.
Properties
-
boundaries : null | ModelRange | undefined
module:engine/model/treewalker~ModelTreeWalkerOptions#boundaries
Range to define boundaries of the iterator.
-
direction : ModelTreeWalkerDirection | undefined
module:engine/model/treewalker~ModelTreeWalkerOptions#direction
-
ignoreElementEnd : boolean | undefined
module:engine/model/treewalker~ModelTreeWalkerOptions#ignoreElementEnd
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 istrue
eachModelElement
will be returned once, while if the option isfalse
they might be returned twice: for'elementStart'
and'elementEnd'
. -
shallow : boolean | undefined
module:engine/model/treewalker~ModelTreeWalkerOptions#shallow
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 | undefined
module:engine/model/treewalker~ModelTreeWalkerOptions#singleCharacters
Flag indicating whether all consecutive characters with the same attributes should be returned one by one as multiple
ModelTextProxy
(true
) objects or as oneModelTextProxy
(false
). -
startPosition : ModelPosition | undefined
module:engine/model/treewalker~ModelTreeWalkerOptions#startPosition
Starting position.