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

Properties

crossOrigin: string

Default

'anonymous'
path: string

Default

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

Type declaration

  • [header: string]: string

Default

{}
resourcePath: string

Default

''
withCredentials: boolean

Default

false
DEFAULT_MATERIAL_NAME: string

Methods

  • 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

  • Parameters

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

          • event: ProgressEvent<EventTarget>

          Returns void

    Returns Promise<HTMLImageElement>

  • Parameters

    • crossOrigin: string

    Returns this

  • Parameters

    • path: string

    Returns this

  • Parameters

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

    Returns this

  • Parameters

    • resourcePath: string

    Returns this

  • Parameters

    • value: boolean

    Returns this