ViewTreeWalkerOptions
interface
The configuration of ViewTreeWalker
.
Properties
-
boundaries : null | ViewRange | undefined
module:engine/view/treewalker~ViewTreeWalkerOptions#boundaries
Range to define boundaries of the iterator.
-
direction : ViewTreeWalkerDirection | undefined
module:engine/view/treewalker~ViewTreeWalkerOptions#direction
-
ignoreElementEnd : boolean | undefined
module:engine/view/treewalker~ViewTreeWalkerOptions#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
eachViewElement
will be returned once, while if the option isfalse
they might be returned twice: for'elementStart'
and'elementEnd'
. -
shallow : boolean | undefined
module:engine/view/treewalker~ViewTreeWalkerOptions#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/view/treewalker~ViewTreeWalkerOptions#singleCharacters
Flag indicating whether all characters from
ViewText
should be returned as oneViewText
(false
) or one by one asViewTextProxy
(true
). -
startPosition : ViewPosition | undefined
module:engine/view/treewalker~ViewTreeWalkerOptions#startPosition
Starting position.