Skip to main content

Class: UixPanelDocument

Defined in: xrblocks-uiextensions/src/panel-document.ts:36

A live spatial panel created from compiled UIKitML JSON. The root is traversable with the core's walk/findRole helpers and the data-uix control upgraders - identical markup works on every adapter.

Extends

  • Group

Implements

Constructors

Constructor

new UixPanelDocument(configJson: unknown, kit?: Kit): UixPanelDocument;

Defined in: xrblocks-uiextensions/src/panel-document.ts:42

Parameters

ParameterType
configJsonunknown
kit?Kit

Returns

UixPanelDocument

Overrides

Group.constructor

Properties

PropertyModifierTypeDefined in
rootComponentreadonlyUikitComponentLikexrblocks-uiextensions/src/panel-document.ts:37

Accessors

root

Get Signature

get root(): UixElement;

Defined in: xrblocks-uiextensions/src/panel-document.ts:59

Root element of the interpreted panel (UixElement-conformant).

Returns

UixElement

Root element of the interpreted panel (UixElement-conformant).

Implementation of

PanelHandle.root

Methods

dispose()

dispose(): void;

Defined in: xrblocks-uiextensions/src/panel-document.ts:84

Release panel resources.

Returns

void

Implementation of

PanelHandle.dispose


getElementById()

getElementById(id: string): UixElement | undefined;

Defined in: xrblocks-uiextensions/src/panel-document.ts:63

Look up an element by its markup id.

Parameters

ParameterType
idstring

Returns

UixElement | undefined

Implementation of

PanelHandle.getElementById


setTargetDimensions()

setTargetDimensions(width: number, height: number): void;

Defined in: xrblocks-uiextensions/src/panel-document.ts:73

Constrain the panel to fit within width × height meters.

Parameters

ParameterType
widthnumber
heightnumber

Returns

void

Implementation of

PanelHandle.setTargetDimensions


update()

update(deltaSeconds: number): void;

Defined in: xrblocks-uiextensions/src/panel-document.ts:80

Drive per-frame - uikit expects milliseconds.

Parameters

ParameterType
deltaSecondsnumber

Returns

void