Skip to content

Class: ImageManager

ImageManager does three things:

  1. Tracks requests for icon images from tile workers and sends responses when the requests are fulfilled.
  2. Builds a texture atlas for pattern images.
  3. Rerenders renderable images once per frame

These are disparate responsibilities and should eventually be handled by different classes. When we implement data-driven support for *-pattern, we'll likely use per-bucket pattern atlases, and that would be a good time to refactor this.

Hierarchy

ImageManager

Methods

listens

listens(type): boolean

Returns a true if this instance of Evented or any forwardeed instances of Evented have a listener for the specified type.

Parameters

Name Type Description
type string The event type

Returns

boolean

true if there is at least one registered listener for specified event type, false otherwise

Inherited from

Evented.listens

Defined in

src/util/evented.ts:163


off

off(type, listener): ImageManager

Removes a previously registered event listener.

Parameters

Name Type Description
type string The event type to remove listeners for.
listener Listener The listener function to remove.

Returns

ImageManager

this

Inherited from

Evented.off

Defined in

src/util/evented.ts:88


on

on(type, listener): this

Adds a listener to a specified event type.

Parameters

Name Type Description
type string The event type to add a listen for.
listener Listener The function to be called when the event is fired. The listener function is called with the data object passed to fire, extended with target and type properties.

Returns

this

this

Inherited from

Evented.on

Defined in

src/util/evented.ts:74


once

once(type, listener?): Promise<any> | ImageManager

Adds a listener that will be called only once to a specified event type.

The listener will be called first time the event fires after the listener is registered.

Parameters

Name Type Description
type string The event type to listen for.
listener? Listener The function to be called when the event is fired the first time.

Returns

Promise<any> | ImageManager

this or a promise if a listener is not provided

Inherited from

Evented.once

Defined in

src/util/evented.ts:104


setEventedParent

setEventedParent(parent?, data?): ImageManager

Bubble all events fired by this instance of Evented to this parent instance of Evented.

Parameters

Name Type
parent? Evented
data? any

Returns

ImageManager

this

Inherited from

Evented.setEventedParent

Defined in

src/util/evented.ts:175

Properties

requestors

requestors: { ids: string[] ; promiseResolve: (value: GetImagesResponse) => void }[]

This is used to track requests for images that are not yet available. When the image is loaded, the requestors will be notified.

Defined in

src/render/image_manager.ts:49