Class Image

Param: extent

Extent.

Param: resolution

Resolution.

Param: pixelRatio

Pixel ratio.

Param: attributions

Attributions.

Param: src

Image source URI.

Param: crossOrigin

Cross origin.

Param: imageLoadFunction

Image load function.

Hierarchy

Constructors

constructor

Methods

getImage load

Constructors

constructor

  • new Image(extent, resolution, pixelRatio, attributions, src, crossOrigin?, imageLoadFunction?): ol.Image

  • Parameters

    • extent: Extent

      Extent.

    • resolution: number

      Resolution.

    • pixelRatio: number

      Pixel ratio.

    • attributions: ol.Attribution[]

      Attributions.

    • src: string

      Image source URI.

    • Optional crossOrigin: string

      Cross origin.

    • Optional imageLoadFunction: ImageLoadFunctionType

      Image load function.

    Returns ol.Image

Methods

getImage

  • getImage(opt_context?): HTMLCanvasElement | ol.Image | HTMLVideoElement

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

    Parameters

    • Optional opt_context: Object

      Object.

    Returns HTMLCanvasElement | ol.Image | HTMLVideoElement

    Image.

    Api

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

    Api

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc