TileTreeOwner Interface

Owns and manages the lifecycle of a TileTree. It is in turn owned by an IModelConnection.Tiles object.

note The only legitimate way to obtain a TileTreeOwner is via Tiles.getTileTreeOwner.

see TileTreeReference for an indirect reference to a TileTree by way of a TileTreeOwner.

see Tiles.getTileTreeOwner to obtain a TileTreeOwner.

Methods

Name Description
dispose(): void Do not call this directly.  
load(): undefined | TileTree If the TileTree has not yet been loaded (TileTreeOwner.loadStatus is NotLoaded), enqueue an asynchronous request to load it (changing TileTreeOwner.loadStatus to TileTreeLoadStatus.Loading).  
loadTree(): Promise<undefined | TileTree> Waits for TileTreeOwner.load, then resolves.  

Properties

Name Type Description
iModel Readonly IModelConnection The iModel for this TileTree  
loadStatus Readonly TileTreeLoadStatus The current load state of the tree.  
tileTree Readonly undefined | TileTree The owned TileTree, or undefined if the tile tree is not loaded.  

Defined in

Last Updated: 12 June, 2024