Function open

  • open(
        source: BFast | BFastSource,
        settings: Partial<VimSettings>,
        onProgress?: (p: IProgressLogs) => void,
    ): Promise<WebglViewer.Vim>

  • Asynchronously opens a vim object from a given source with the provided settings.

    Parameters

    • source: BFast | BFastSource

      The source of the vim object, either a string or a BFast.

    • settings: Partial<VimSettings>

      The settings to configure the behavior of the vim object.

    • OptionalonProgress: (p: IProgressLogs) => void

      Optional callback function to track progress logs.

    Returns Promise<WebglViewer.Vim>

    A Promise that resolves when the vim object is successfully opened.

Settings

Member Visibility