Skip to main content

ui.get_node

Overview

  • Expands one node of the UI tree, identified by the ref that ui.get_tree or ui.find gave you. Use this for the parts ui.get_tree folded away ({role:'more'}) or cut with the node budget, instead of re-fetching the whole screen with a bigger budget. Unlike ui.get_tree this defaults to showing non-interactive structure too, since the point is to look closer. Fails when the ref no longer resolves - a window may have closed, or a list entry may have been recycled by scrolling, in which case re-query ui.get_tree for a fresh ref.

Metadata

FieldValue
DisplayGet UI Node
Categoryui
AccessPublic
ScopeB1Standalone
TagsExperimental
Aliases—

Parameters

NameTypeRequiredDefaultDescription
refstringno—Node ref from ui.get_tree / ui.find.
depthintno2Maximum depth below the node. 0 = unlimited.
max_nodesintno150Node budget for the response [1-5000].
include_offscreenboolnofalseInclude nodes whose rect lies outside the viewport.
show_decorboolnofalseInclude decoration nodes (images, spacers, throbbers).

Usage

await inzoi.cli.execute('ui.get_node', {
ref: '', // optional
depth: 2, // optional
max_nodes: 150, // optional
include_offscreen: false, // optional
show_decor: false, // optional
});