Class ImageLoader

A loader for loading an image. Unlike other loaders, this one emits events instead of using predefined callbacks. So if you're interested in getting notified when things happen, you need to add listeners to the object.

Hierarchy (view full)

  • Loader<HTMLImageElement>
    • ImageLoader

Constructors

constructor

Properties

crossOrigin manager path requestHeader resourcePath withCredentials DEFAULT_MATERIAL_NAME

Methods

load loadAsync setCrossOrigin setPath setRequestHeader setResourcePath setWithCredentials

Constructors

constructor

Properties

crossOrigin

crossOrigin: string

Default

'anonymous'

manager

manager: LoadingManager

path

path: string

Default

''

requestHeader

requestHeader: {
    [header: string]: string;
}

Type declaration

  • [header: string]: string

Default

{}

resourcePath

resourcePath: string

Default

''

withCredentials

withCredentials: boolean

Default

false

Static DEFAULT_MATERIAL_NAME

DEFAULT_MATERIAL_NAME: string

Methods

load

  • load(url, onLoad?, onProgress?, onError?): HTMLImageElement

  • Parameters

    • url: string
    • Optional onLoad: ((data) => void)
        • (data): void

        • Parameters

          • data: HTMLImageElement

          Returns void

    • Optional onProgress: ((event) => void)
        • (event): void

        • Parameters

          • event: ProgressEvent<EventTarget>

          Returns void

    • Optional onError: ((err) => void)
        • (err): void

        • Parameters

          • err: unknown

          Returns void

    Returns HTMLImageElement

loadAsync

  • loadAsync(url, onProgress?): Promise<HTMLImageElement>

  • Parameters

    • url: string
    • Optional onProgress: ((event) => void)
        • (event): void

        • Parameters

          • event: ProgressEvent<EventTarget>

          Returns void

    Returns Promise<HTMLImageElement>

setCrossOrigin

  • setCrossOrigin(crossOrigin): this

  • Parameters

    • crossOrigin: string

    Returns this

setPath

  • setPath(path): this

  • Parameters

    • path: string

    Returns this

setRequestHeader

  • setRequestHeader(requestHeader): this

  • Parameters

    • requestHeader: {
          [header: string]: string;
      }
      • [header: string]: string

    Returns this

setResourcePath

  • setResourcePath(resourcePath): this

  • Parameters

    • resourcePath: string

    Returns this

setWithCredentials

  • setWithCredentials(value): this

  • Parameters

    • value: boolean

    Returns this

Settings

Member Visibility

On This Page

constructorcrossOriginmanagerpathrequestHeaderresourcePathwithCredentialsDEFAULT_MATERIAL_NAMEloadloadAsyncsetCrossOriginsetPathsetRequestHeadersetResourcePathsetWithCredentials