Interface ClusterHandle

Imperative handle returned by cluster.

interface ClusterHandle {
    layout(): void;
    element: BoxElement;
    destroy(): void;
    setData(data: ClusterData): void;
}

Hierarchy (View Summary)

BlessedComponentHandle<ClusterData, blessed.Widgets.BoxElement>
- ClusterHandle

Index

Properties

Methods

layout destroy setData

Properties

`Readonly`element

element: BoxElement

Underlying Blessed element available for standard element operations.

Methods

layout

layout(): void
Recalculates positions for current direct children.

Returns void
- Defined in adapters/blessed/cluster.ts:46

destroy

destroy(): void
Destroys and detaches the owned element without destroying its parent.

Returns void
Inherited from BlessedComponentHandle.destroy
- Defined in adapters/blessed/types.ts:23

setData

setData(data: ClusterData): void
Re-renders component content using complete replacement data.

The element identity is preserved. Call screen.render() explicitly when one or more updates should become visible.
Parameters
- data: ClusterData
Returns void
Inherited from BlessedComponentHandle.setData
- Defined in adapters/blessed/types.ts:31