Class ComponentLoader

Provides functionality for asynchronously opening sources and tracking progress. Includes event emitters for progress updates and completion notifications.

Hierarchy

  • ComponentLoader

Constructors

constructor

Properties

loadCount

Accessors

onDone onProgress

Methods

close open

Constructors

constructor

Properties

loadCount

loadCount: number

Accessors

onDone

onProgress

  • get onProgress(): ISimpleEvent<IProgressLogs>

  • Event emitter for progress updates.

    Returns ISimpleEvent<IProgressLogs>

Methods

close

  • Removes the vim from the viewer and disposes it.

    Parameters

    • vim: Vim

      Vim to remove from the viewer.

    Returns void

open

  • Asynchronously opens a vim at source, applying the provided settings.

    Parameters

    • source: string | ArrayBuffer

      The source to open, either as a string or ArrayBuffer.

    • settings: LoadSettings

      Partial settings to apply to the opened source.

    • Optional onProgress: ((p: IProgressLogs) => void)

      Optional callback function to track progress during opening. Receives progress logs as input.

        • (p: IProgressLogs): void

        • Parameters

          • p: IProgressLogs

          Returns void

    Returns Promise<Vim>

Settings

Member Visibility

Theme

Generated using TypeDoc