Interface ILoadersRegistry

Defines the viewer loaders registry interface.

interface ILoadersRegistry {
    createLoader(
        viewer: IViewer,
        file: FileSource,
        format?: string,
    ): ILoader;
    getLoaders(): Map<string, ILoaderProvider>;
    registerLoader(name: string, provider: ILoaderProvider): void;
}

Index

Methods

createLoader getLoaders registerLoader

Methods

createLoader

createLoader(viewer: IViewer, file: FileSource, format?: string): ILoader
Creates the loader of the specified file. Returns null if the file format is not supported.
Parameters
- viewer: IViewer
  Viewer instance that wants to create the loader.
- file: FileSource
- Optionalformat: string
Returns ILoader

getLoaders

getLoaders(): Map<string, ILoaderProvider>
Returns a list of registered loaders.

Returns Map<string, ILoaderProvider>

registerLoader

registerLoader(name: string, provider: ILoaderProvider): void
Binds a loader name to a loader. Registering a loader with an existing name twice overrides the existing loader.
Parameters
- name: string
  Unique name for the loader.
- provider: ILoaderProvider
  Loader provider.
Returns void