Class LayoutTree

Manages a tree of LayoutNodes with dirty tracking and batched updates.

Index

Constructors

Accessors

height root width

Methods

addChild computeNow createNode dispose find getComputedLayout getDirtyCount getNode isDirty markDirty removeChild removeNode setDebug setOnLayoutComplete setSize traverse

Constructors

constructor

new LayoutTree(options: LayoutTreeOptions): LayoutTree
Parameters
- options: LayoutTreeOptions
Returns LayoutTree
- Defined in layout/layout-tree.ts:58

Accessors

height

get height(): number
Get available height

Returns number
- Defined in layout/layout-tree.ts:94

root

get root(): LayoutNode
Get the root node

Returns LayoutNode
- Defined in layout/layout-tree.ts:80

width

get width(): number
Get available width

Returns number
- Defined in layout/layout-tree.ts:87

Methods

addChild

addChild(parent: LayoutNode, child: LayoutNode, index?: number): void
Add a child node to a parent
Parameters
- parent: LayoutNode
- child: LayoutNode
- Optionalindex: number
Returns void
- Defined in layout/layout-tree.ts:121

computeNow

computeNow(): void
Force immediate layout computation

Returns void
- Defined in layout/layout-tree.ts:224

createNode

createNode(
    id: string,
    parent: LayoutNode,
    style?: Partial<LayoutNode["style"]>,
    options?: {
        index?: number;
        intrinsicSize?: { height: number; width: number };
        measureFn?: () => { height: number; width: number };
    },
): LayoutNode
Create and add a new node
Parameters
- id: string
- parent: LayoutNode
- Optionalstyle: Partial<LayoutNode["style"]>
- Optionaloptions: {
      index?: number;
      intrinsicSize?: { height: number; width: number };
      measureFn?: () => { height: number; width: number };
  }
Returns LayoutNode
- Defined in layout/layout-tree.ts:166

dispose

dispose(): void
Dispose the tree and clear all nodes

Returns void
- Defined in layout/layout-tree.ts:309

find

find(predicate: (node: LayoutNode) => boolean): LayoutNode[]
Find nodes matching a predicate
Parameters
- predicate: (node: LayoutNode) => boolean
Returns LayoutNode[]
- Defined in layout/layout-tree.ts:296

getComputedLayout

getComputedLayout(node: LayoutNode): FlexComputedLayout
Get computed layout for a node
Parameters
- node: LayoutNode
Returns FlexComputedLayout
- Defined in layout/layout-tree.ts:250

getDirtyCount

getDirtyCount(): number
Get the number of dirty nodes

Returns number
- Defined in layout/layout-tree.ts:264

getNode

getNode(id: string): LayoutNode
Get a node by ID
Parameters
- id: string
Returns LayoutNode
- Defined in layout/layout-tree.ts:114

isDirty

isDirty(): boolean
Check if any nodes are dirty

Returns boolean
- Defined in layout/layout-tree.ts:257

markDirty

markDirty(node: LayoutNode, reason: DirtyReason): void
Mark a node as dirty (needs re-layout)
Parameters
- node: LayoutNode
- reason: DirtyReason
Returns void
- Defined in layout/layout-tree.ts:197

removeChild

removeChild(parent: LayoutNode, child: LayoutNode): void
Remove a child node from its parent
Parameters
- parent: LayoutNode
- child: LayoutNode
Returns void
- Defined in layout/layout-tree.ts:150

removeNode

removeNode(node: LayoutNode): void
Remove and dispose a node
Parameters
- node: LayoutNode
Returns void
- Defined in layout/layout-tree.ts:188

setDebug

setDebug(debug: boolean): void
Enable or disable debug mode
Parameters
- debug: boolean
Returns void
- Defined in layout/layout-tree.ts:278

setOnLayoutComplete

setOnLayoutComplete(callback: LayoutCompleteCallback): void
Set the layout complete callback
Parameters
- callback: LayoutCompleteCallback
Returns void
- Defined in layout/layout-tree.ts:271

setSize

setSize(width: number, height: number): void
Update available dimensions
Parameters
- width: number
- height: number
Returns void
- Defined in layout/layout-tree.ts:101

traverse

traverse(
callback: (node: LayoutNode, depth: number) => void,
startNode?: LayoutNode,
): void
Traverse the tree depth-first
Parameters
- callback: (node: LayoutNode, depth: number) => void
- OptionalstartNode: LayoutNode
Returns void
- Defined in layout/layout-tree.ts:285