On this page
Constructors
Properties
Methods

Class ImageManager

Methods mixed in to other classes for event capabilities.

Hierarchy (View Summary)

Index

Constructors

constructor

Properties

atlasImage atlasTexture callbackDispatchedThisFrame dirty images loaded patterns requestors updatedImages

Methods

addImage beginFrame bind cloneImages destroy dispatchRenderCallbacks fire getImage getImages getPattern getPixelSize isLoaded listens listImages off on once removeImage setEventedParent setLoaded updateImage

Constructors

Properties

atlasImage: RGBAImage
atlasTexture: Texture
callbackDispatchedThisFrame: { [_: string]: boolean }
dirty: boolean
images: { [_: string]: StyleImage }
loaded: boolean
patterns: { [_: string]: Pattern }
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.

updatedImages: { [_: string]: boolean }

Methods

  • Returns void

  • Returns void

  • Parameters

    • ids: string[]

    Returns void

  • Parameters

    • event: string | Event
    • Optionalproperties: any

    Returns this

  • Returns { height: number; width: number }

  • Returns boolean

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

    Parameters

    • type: string

      The event type

    Returns boolean

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

  • Returns string[]

  • Removes a previously registered event listener.

    Parameters

    • type: string

      The event type to remove listeners for.

    • listener: Listener

      The listener function to remove.

    Returns this

  • Adds a listener to a specified event type.

    Parameters

    • 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 Subscription

  • 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

    • type: string

      The event type to listen for.

    • Optionallistener: Listener

      The function to be called when the event is fired the first time.

    Returns ImageManager | Promise<any>

    this or a promise if a listener is not provided

  • Parameters

    • id: string

    Returns void

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

    Parameters

    • Optionalparent: Evented | null
    • Optionaldata: any

    Returns this

  • Parameters

    • loaded: boolean

    Returns void

  • Parameters

    • id: string
    • image: StyleImage
    • Optionalvalidate: boolean

    Returns void

Was this helpful?
SDK JS
Reference
ImageManager