Skip to content

Class: UIKitMLAsset

Defined in: packages/core/src/ui/uikitml-asset.ts:13

Object hierarchy produced when a UIKitML manifest asset is instantiated.

Extends

  • Group

Constructors

Constructor

new UIKitMLAsset(assetId, document): UIKitMLAsset

Defined in: packages/core/src/ui/uikitml-asset.ts:16

Parameters

assetId

string

document

UIKitDocument

Returns

UIKitMLAsset

Overrides

Group.constructor

Properties

assetId

readonly assetId: string

Defined in: packages/core/src/ui/uikitml-asset.ts:17


document

readonly document: UIKitDocument

Defined in: packages/core/src/ui/uikitml-asset.ts:18


isUIKitMLAsset

readonly isUIKitMLAsset: true = true

Defined in: packages/core/src/ui/uikitml-asset.ts:14

Methods

dispose()

dispose(): void

Defined in: packages/core/src/ui/uikitml-asset.ts:38

Release the document even when ScreenSpace has temporarily reparented it.

Returns

void


getElementById()

getElementById<T>(id): T

Defined in: packages/core/src/ui/uikitml-asset.ts:26

Find a UIKit element without first dereferencing document.

Type Parameters

T

T extends Component<any> = Component<any>

Parameters

id

string

Returns

T


requireElementById()

requireElementById<T>(id): T

Defined in: packages/core/src/ui/uikitml-asset.ts:33

Return a typed UIKit element or throw when the id is absent.

Type Parameters

T

T extends Component<any> = Component<any>

Parameters

id

string

Returns

T

Privacy | Terms