Class: Image

ol.source.Image

Abstract base class; normally only used for creating subclasses and not instantiated in apps. Base class for sources providing a single image.

new ol.source.Image(options) experimental

src/ol/source/imagesource.js, line 39
Name Type Description
options ol.source.ImageOptions

Single image source options.

Fires:
  • change experimental - Triggered when the revision counter is increased.
  • propertychange (ol.ObjectEvent) - Triggered when a property is changed.

Subclasses

Extends

Methods

changed() inherited experimental

src/ol/observable.js, line 51

Increases the revision counter and dispatches a 'change' event.

dispatchEvent(event) inherited experimental

src/ol/observable.js, line 73

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.

Name Type Description
event goog.events.EventLike

Event object.

get(key){*} inherited

src/ol/object.js, line 149

Gets a value.

Name Type Description
key string

Key name.

Returns:
Value.

getAttributions(){Array.<ol.Attribution>} inherited

src/ol/source/source.js, line 105

Get the attributions of the source.

Returns:
Attributions.

getKeys(){Array.<string>} inherited

src/ol/object.js, line 163

Get a list of object property names.

Returns:
List of property names.
src/ol/source/source.js, line 115

Get the logo of the source.

Returns:
Logo.

getProjection(){ol.proj.Projection} inherited experimental

src/ol/source/source.js, line 125

Get the projection of the source.

Returns:
Projection.

getProperties(){Object.<string, *>} inherited

src/ol/object.js, line 173

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited experimental

src/ol/observable.js, line 82

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:
Revision.

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

src/ol/source/source.js, line 141

Get the state of the source, see ol.source.State for possible states.

Returns:
State.

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

src/ol/observable.js, line 95

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

The object to use as this in listener.

Returns:
Unique key for the listener.

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

src/ol/observable.js, line 108

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

The object to use as this in listener.

Returns:
Unique key for the listener.

set(key, value, opt_silent) inherited

src/ol/object.js, line 203

Sets a value.

Name Type Description
key string

Key name.

value *

Value.

silent boolean

Update without triggering an event.

setAttributions(attributions) inherited experimental

src/ol/source/source.js, line 159

Set the attributions of the source.

Name Type Description
attributions Array.<ol.Attribution>

Attributions.

setProperties(values, opt_silent) inherited

src/ol/object.js, line 221

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name Type Description
values Object.<string, *>

Values.

silent boolean

Update without triggering an event.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 121

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

The object which was used as this by the listener.

unByKey(key) inherited

src/ol/observable.js, line 134

Removes an event listener using the key returned by on() or once(). Note that using the ol.Observable.unByKey static function is to be preferred.

Name Type Description
key goog.events.Key

The key returned by on() or once().

unset(key, opt_silent) inherited

src/ol/object.js, line 235

Unsets a property.

Name Type Description
key string

Key name.

silent boolean

Unset without triggering an event.