TreeWalkerOptions (engine/model)
@ckeditor/ckeditor5-engine/src/model/treewalker
The configuration of TreeWalker.
All parameters are optional, but you have to specify either boundaries
or startPosition
.
Filtering
Properties
-
boundaries : null | Range | undefined
module:engine/model/treewalker~TreeWalkerOptions#boundaries
Range to define boundaries of the iterator.
-
direction : TreeWalkerDirection | undefined
module:engine/model/treewalker~TreeWalkerOptions#direction
-
ignoreElementEnd : boolean | undefined
module:engine/model/treewalker~TreeWalkerOptions#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
eachElement
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~TreeWalkerOptions#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~TreeWalkerOptions#singleCharacters
-
startPosition : Position | undefined
module:engine/model/treewalker~TreeWalkerOptions#startPosition
Starting position.
Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.