OpenLayers 3 API Documentation

Class: ImageStatic

ol.source.ImageStatic

An image source for 'static', that is, non-georeferenced, images. See examples/static-image for example.

new ol.source.ImageStatic(options) experimental

src/ol/source/imagestaticsource.js, line 20
Name Type Description
options

Options.

Name Type Description
attributions Array.<ol.Attribution> | undefined optional

Attributions.
crossOrigin null | string | undefined optional

crossOrigin setting for image requests.
extent ol.Extent | undefined optional

Extent.
imageExtent ol.Extent | undefined optional

Extent of the image.
imageSize ol.Size | undefined optional

Size of the image.
logo string | undefined optional

Logo.
projection ol.proj.ProjectionLike

Projection.
url string

Url.
Fires:
  • change experimental - Triggered when the state of the source changes.

Extends

Methods

dispatchChangeEvent() inherited experimental

src/ol/observable.js, line 41

Dispatches a change event.

Fires:
  • change experimental

getState(){ol.source.State} inherited experimental

src/ol/source/source.js, line 142
Returns:
State.

on(type, listener, opt_this){goog.events.Key} inherited experimental

src/ol/observable.js, line 63

Listen for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object optional

The object to use as this in listener.
Returns:
Unique key for the listener.

once(type, listener, opt_this){goog.events.Key} inherited experimental

src/ol/observable.js, line 76

Listen once for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object optional

The object to use as this in listener.
Returns:
Unique key for the listener.

un(type, listener, opt_this) inherited experimental

src/ol/observable.js, line 88

Unlisten for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object optional

The object to use as this in listener.

unByKey(key) inherited experimental

src/ol/observable.js, line 98

Removes an event listener using the key returned by on() or once().

Name Type Description
key goog.events.Key

Key.