Class TreeData<Node>

Type parameters

Node

Hierarchy

TreeData

Index

Constructors

constructor

Properties

Accessors

rootChildren

Methods

Constructors

constructor

new TreeData<Node>(data?: Node | Node[]): TreeData<Node>

- Defined in index.ts:1172
Type parameters
- Node
Parameters
- data: Node | Node[] = []
Returns TreeData<Node>

Properties

childrenKey

childrenKey: string = "children"

data

data: Node | Node[]

Accessors

rootChildren

get rootChildren(): Node[]

- Defined in index.ts:1175
Returns Node[]

Methods

clone

clone(opt?: { nodeHandler?: CloneTreeNodeHandler<Node> }): { childrenKey: string; nodeHandler: CloneTreeNodeHandler<Node> }

- Defined in index.ts:1265
Parameters
- opt: { nodeHandler?: CloneTreeNodeHandler<Node> } = {}
  - Optional nodeHandler?: CloneTreeNodeHandler<Node>
Returns { childrenKey: string; nodeHandler: CloneTreeNodeHandler<Node> }
- childrenKey: string
- nodeHandler: CloneTreeNodeHandler<Node>

delete

delete(path: TreeDataPath): Node

- Defined in index.ts:1251
Parameters
- path: TreeDataPath
Returns Node

get

get(path: TreeDataPath): Node

- Defined in index.ts:1213
Parameters
- path: TreeDataPath
Returns Node

getFamily

getFamily(path: TreeDataPath): Node[]

- Defined in index.ts:1206
Parameters
- path: TreeDataPath
Returns Node[]

getParent

getParent(path: TreeDataPath): Node

- Defined in index.ts:1221
Parameters
- path: TreeDataPath
Returns Node

getParentAndIndex

getParentAndIndex(path: TreeDataPath): { index: number; parent: Node; parentPath: number[] }

- Defined in index.ts:1216
Parameters
- path: TreeDataPath
Returns { index: number; parent: Node; parentPath: number[] }
- index: number
- parent: Node
- parentPath: number[]

iteratePath

iteratePath(path: TreeDataPath, opt?: { reverse?: boolean }): IterableIterator<{ node: Node; path: TreeDataPath }>

- Defined in index.ts:1180
Parameters
- path: TreeDataPath
- opt: { reverse?: boolean } = {}
  - Optional reverse?: boolean
Returns IterableIterator<{ node: Node; path: TreeDataPath }>

set

set(path: TreeDataPath, node: Node): void

- Defined in index.ts:1224
Parameters
- path: TreeDataPath
- node: Node
Returns void

walk

walk(handler: WalkTreeDataHandler<Node>, opt?: { reverse?: boolean }): void

- Defined in index.ts:1260
Parameters
- handler: WalkTreeDataHandler<Node>
- Optional opt: { reverse?: boolean }
  - Optional reverse?: boolean
Returns void

Generated using TypeDoc