# ViewTreeWalkerOptions

interface

The configuration of [`ViewTreeWalker`](module_engine_view_treewalker-ViewTreeWalker.md).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/treewalker.ts#L539)

<a id="properties">

## Properties

<a id="member-boundaries">

### `boundaries?: ViewRange | null`

Range to define boundaries of the iterator.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/treewalker.ts#L551)

<a id="member-direction">

### `direction?: ViewTreeWalkerDirection`

Walking direction.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/treewalker.ts#L546)

Defaults to `'forward'`

<a id="member-ignoreElementEnd">

### `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 [`ViewElement`](module_engine_view_element-ViewElement.md) will be returned once, while if the option is `false` they might be returned twice: for `'elementStart'` and `'elementEnd'`.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/treewalker.ts#L578)

<a id="member-shallow">

### `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.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/treewalker.ts#L570)

<a id="member-singleCharacters">

### `singleCharacters?: boolean`

Flag indicating whether all characters from [`ViewText`](module_engine_view_text-ViewText.md) should be returned as one [`ViewText`](module_engine_view_text-ViewText.md) (`false`) or one by one as [`ViewTextProxy`](module_engine_view_textproxy-ViewTextProxy.md) (`true`).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/treewalker.ts#L564)

<a id="member-startPosition">

### `startPosition?: ViewPosition`

Starting position.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/treewalker.ts#L556)

---

Full index of the CKEditor 5 API reference: [llms.txt](llms.txt)