Class: Static

ol/source/ImageStatic~Static


import Static from 'ol/source/ImageStatic';

A layer source for displaying a single, static image.

new Static(options)

source/ImageStatic.js, line 36
Name Type Description
options

ImageStatic options.

Name Type Description
attributions module:ol/source/Source~AttributionLike

Attributions.

crossOrigin null | string

The crossOrigin attribute for loaded images. Note that you must provide a crossOrigin value if you are using the WebGL renderer or if you want to access pixel data with the Canvas renderer. See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.

imageExtent module:ol/extent~Extent

Extent of the image in map coordinates. This is the [left, bottom, right, top] map coordinates of your image.

imageLoadFunction module:ol/Image~LoadFunction

Optional function to load an image given a URL.

projection module:ol/proj~ProjectionLike

Projection.

imageSize module:ol/size~Size

Size of the image in pixels. Usually the image size is auto-detected, so this only needs to be set if auto-detection fails for some reason.

url string

Image URL.

Fires:

Extends

Methods

getImageExtent(){module:ol/extent~Extent}

source/ImageStatic.js, line 87

Returns the image extent

Returns:
image extent.

getProjection(){module:ol/proj/Projection~Projection} inherited

source/Source.js, line 119

Get the projection of the source.

Returns:
Projection.

getState(){module:ol/source/State} inherited

source/Source.js, line 136

Get the state of the source, see module:ol/source/State~State for possible states.

Returns:
State.

getUrl(){string}

source/ImageStatic.js, line 106

Return the URL used for this image source.

Returns:
URL.

refresh() inherited

source/Source.js, line 151

Refreshes the source and finally dispatches a 'change' event.

setAttributions(attributions) inherited

source/Source.js, line 162

Set the attributions of the source.

Name Type Description
attributions module:ol/source/Source~AttributionLike | undefined

Attributions. Can be passed as string, Array<string>, module:ol/source/Source&tilde;Attribution, or undefined.