Class BreadthFirstTreeIterator

Hierarchy (View Summary)

AbstractTreeIterator
- BreadthFirstTreeIterator

Index

Constructors

Properties

delegate options root

Methods

[iterator] children isCollapsed isEmpty iterator next

Constructors

constructor

new BreadthFirstTreeIterator(
root: TreeNode,
options?: Partial<TreeIterator.Options>,
): BreadthFirstTreeIterator
Parameters
- root: TreeNode
- Optionaloptions: Partial<TreeIterator.Options>
Returns BreadthFirstTreeIterator
Inherited from AbstractTreeIterator.constructor
- Defined in packages/core/src/browser/tree/tree-iterator.ts:42

Properties

`Protected` `Readonly`delegate

delegate: IterableIterator<TreeNode>

`Protected` `Readonly`options

options: TreeIterator.Options

`Protected` `Readonly`root

Methods

[iterator]

"[iterator]"(): IterableIterator<TreeNode>
tslint:disable-next-line:typedef

Returns IterableIterator<TreeNode>
Inherited from AbstractTreeIterator.[iterator]
- Defined in packages/core/src/browser/tree/tree-iterator.ts:51

`Protected`children

children(node: TreeNode): undefined | TreeNode[]
Parameters
- node: TreeNode
Returns undefined | TreeNode[]
Inherited from AbstractTreeIterator.children
- Defined in packages/core/src/browser/tree/tree-iterator.ts:61

`Protected`isCollapsed

isCollapsed(node: TreeNode): boolean
Parameters
- node: TreeNode
Returns boolean
Inherited from AbstractTreeIterator.isCollapsed
- Defined in packages/core/src/browser/tree/tree-iterator.ts:71

`Protected`isEmpty

isEmpty(nodes: undefined | TreeNode[]): boolean
Parameters
- nodes: undefined | TreeNode[]
Returns boolean
Inherited from AbstractTreeIterator.isEmpty
- Defined in packages/core/src/browser/tree/tree-iterator.ts:75

`Protected`iterator

iterator(root: TreeNode): IterableIterator<TreeNode>
Parameters
- root: TreeNode
Returns IterableIterator<TreeNode>
Overrides AbstractTreeIterator.iterator
- Defined in packages/core/src/browser/tree/tree-iterator.ts:91

next

next(): IteratorResult<TreeNode>
NOTE: 'next' is defined using a tuple to ensure we report the correct assignability errors in all places.

Returns IteratorResult<TreeNode>
Inherited from AbstractTreeIterator.next
- Defined in packages/core/src/browser/tree/tree-iterator.ts:55