@itwin/core-frontend/lib/esm/tile/TileTreeOwner.d.ts

iTwin.js frontend components

/** @packageDocumentation
 * @module Tiles
 */
import { IModelConnection } from "../IModelConnection";
import { TileTree, TileTreeLoadStatus } from "./internal";
/** 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.
 * @public
 * @extensions
 */
export interface TileTreeOwner {
    /** The iModel for this TileTree */
    readonly iModel: IModelConnection;
    /** The owned [[TileTree]], or `undefined` if the tile tree is not loaded.
     * @note Do not store a direct reference to the TileTree, because it may become disposed by its owner.
     * @see [[TileTreeOwner.load]] to ensure the tree is enqueued for loading if necessary.
     */
    readonly tileTree: TileTree | undefined;
    /** The current load state of the tree. This can be reset to NotLoaded after loading if the owner becomes disposed or the tree is not used for a long period of time.
     * [[tileTree]] will be `undefined` unless `loadStatus` is [[TileTreeLoadStatus.Loaded]].
     * @see [[TileTreeOwner.load]] to ensure the tree is enqueued for loading if necessary.
     */
    readonly loadStatus: TileTreeLoadStatus;
    /** If the TileTree has not yet been loaded ([[loadStatus]] is [[TileTreeStatus.NotLoaded]]), enqueue an asynchronous request to load it (changing [[loadStatus]] to [[TileTreeLoadStatus.Loading]]).
     * [[loadStatus]] will be updated to [[TileTreeLoadStatus.Loaded]] when that request succeeds, or [[TileTreeLoadStatus.NotFound]] if the request fails.
     * @returns the loaded TileTree if loading completed successfully, or undefined if the tree is still loading or loading failed.
     */
    load(): TileTree | undefined;
    /** Do not call this directly.
     * @internal
     */
    [Symbol.dispose](): void;
    /** Waits for [[load]], then resolves. It is generally preferable to call [[load]] directly rather than `await`ing this method. */
    loadTree(): Promise<TileTree | undefined>;
}
//# sourceMappingURL=TileTreeOwner.d.ts.map