Class ImageTile

Classdesc

Base class for tiles.

Abstract

Hierarchy (view full)

Constructors

constructor

Properties

disposed interimTile interpolate key state tileCoord transitionStarts_ transition_

Methods

addEventListener changed dispatchEvent dispose disposeInternal endTransition getAlpha getImage getInterimTile getKey getListeners getState getTileCoord hasListener inTransition load refreshInterimChain release removeEventListener setImage setState

Constructors

constructor

  • new ImageTile(tileCoord, state, src, crossOrigin, tileLoadFunction, options?): ImageTile

  • Parameters

    • tileCoord: TileCoord

      Tile coordinate.

    • state: any

      State.

    • src: string

      Image source URI.

    • crossOrigin: null | string

      Cross origin.

    • tileLoadFunction: LoadFunction

      Tile load function.

    • Optional options: Options

      Tile options.

    Returns ImageTile

Properties

Protected disposed

disposed: boolean

The object has already been disposed.

interimTile

interimTile: external.ol.Tile

An "interim" tile for this tile. The interim tile may be used while this one is loading, for "smooth" transitions when changing params/dimensions on the source.

interpolate

interpolate: boolean

key

key: string

A key assigned to the tile. This is used by the tile source to determine if this tile can effectively be used, or if a new tile should be created and this one be used as an interim tile for this new tile.

Protected state

state: any

tileCoord

tileCoord: TileCoord

transitionStarts_

transitionStarts_: {
    [x: string]: number;
}

Lookup of start times for rendering transitions. If the start time is equal to -1, the transition is complete.

Type declaration

  • [x: string]: number

transition_

transition_: number

The duration for the opacity transition.

Methods

addEventListener

  • addEventListener(type, listener): void

  • Parameters

    • type: string

      Type.

    • listener: Listener

      Listener.

    Returns void

Protected changed

  • changed(): void
  • Protected

    Returns void

dispatchEvent

  • dispatchEvent(event): undefined | boolean

  • Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

    Parameters

    • event: string | BaseEvent

      Event object.

    Returns undefined | boolean

    false if anyone called preventDefault on the event object or if any of the listeners returned false.

    Api

dispose

  • dispose(): void

  • Clean up.

    Returns void

Protected disposeInternal

  • disposeInternal(): void
  • Protected

    Extension point for disposable objects.

    Returns void

endTransition

  • endTransition(id): void

  • Mark a transition as complete.

    Parameters

    • id: string

      An id for the renderer.

    Returns void

getAlpha

  • getAlpha(id, time): number

  • Get the alpha value for rendering.

    Parameters

    • id: string

      An id for the renderer.

    • time: number

      The render frame time.

    Returns number

    A number between 0 and 1.

getImage

  • getImage(): HTMLImageElement | HTMLCanvasElement | HTMLVideoElement

  • Get the HTML image element for this tile (may be a Canvas, Image, or Video).

    Returns HTMLImageElement | HTMLCanvasElement | HTMLVideoElement

    Image.

    Api

getInterimTile

  • getInterimTile(): external.ol.Tile

  • Get the interim tile most suitable for rendering using the chain of interim tiles. This corresponds to the most recent tile that has been loaded, if no such tile exists, the original tile is returned.

    Returns external.ol.Tile

    Best tile for rendering.

getKey

  • getKey(): string

  • Returns string

    Key.

getListeners

  • getListeners(type): undefined | Listener[]

  • Get the listeners for a specified event type. Listeners are returned in the order that they will be called in.

    Parameters

    • type: string

      Type.

    Returns undefined | Listener[]

    Listeners.

getState

  • getState(): any

  • Returns any

    State.

getTileCoord

  • getTileCoord(): TileCoord

  • Get the tile coordinate for this tile.

    Returns TileCoord

    The tile coordinate.

    Api

hasListener

  • hasListener(type?): boolean

  • Parameters

    • Optional type: string

      Type. If not provided, true will be returned if this event target has any listeners.

    Returns boolean

    Has listeners.

inTransition

  • inTransition(id): boolean

  • Determine if a tile is in an alpha transition. A tile is considered in transition if tile.getAlpha() has not yet been called or has been called and returned 1.

    Parameters

    • id: string

      An id for the renderer.

    Returns boolean

    The tile is in transition.

load

  • load(): void

  • Load the image or retry if loading previously failed. Loading is taken care of by the tile queue, and calling this method is only needed for preloading or for reloading in case of an error.

    Returns void

    Abstract

    Api

refreshInterimChain

  • refreshInterimChain(): void

  • Goes through the chain of interim tiles and discards sections of the chain that are no longer relevant.

    Returns void

release

  • release(): void

  • Called by the tile cache when the tile is removed from the cache due to expiry

    Returns void

removeEventListener

  • removeEventListener(type, listener): void

  • Parameters

    • type: string

      Type.

    • listener: Listener

      Listener.

    Returns void

setImage

  • setImage(element): void

  • Sets an HTML image element for this tile (may be a Canvas or preloaded Image).

    Parameters

    • element: HTMLImageElement | HTMLCanvasElement

      Element.

    Returns void

setState

  • setState(state): void

  • Sets the state of this tile. If you write your own module:ol/TileLoadFunction tileLoadFunction , it is important to set the state correctly to module:ol/TileStateERROR when the tile cannot be loaded. Otherwise the tile cannot be removed from the tile queue and will block other requests.

    Parameters

    • state: any

      State.

    Returns void

    Api

Settings

Member Visibility

On This Page

constructordisposedinterimTileinterpolatekeystatetileCoordtransitionStarts_transition_addEventListenerchangeddispatchEventdisposedisposeInternalendTransitiongetAlphagetImagegetInterimTilegetKeygetListenersgetStategetTileCoordhasListenerinTransitionloadrefreshInterimChainreleaseremoveEventListenersetImagesetState