OpenLayers 3

Class: ImageStatic

ol.source.ImageStatic

A layer source for displaying a single, static image.

new ol.source.ImageStatic(options)

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

Options.

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

Attributions.
crossOrigin null | string | undefined

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 ol.Extent

Extent of the image in map coordinates. This is the [left, bottom, right, top] map coordinates of your image.
imageSize ol.Size | undefined

Size of the image in pixels.
imageLoadFunction ol.TileLoadFunctionType | undefined experimental

Optional function to load an image given a URL.
logo string | olx.LogoOptions | undefined

Optional logo.
projection ol.proj.ProjectionLike experimental

Projection.
url string

Image URL.
Fires:

Extends

Methods

changed() inherited experimental

src/ol/observable.js, line 52

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

Fires:
  • change experimental

get(key){*} inherited

src/ol/object.js, line 150

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

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

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

Get the attributions of the source.

Returns:
Attributions.

getKeys(){Array.<string>} inherited

src/ol/object.js, line 164

Get a list of object property names.

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

Get the logo of the source.

Returns:
Logo.

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

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

Get the projection of the source.

Returns:
Projection.

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

src/ol/object.js, line 174

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited experimental

src/ol/observable.js, line 62
Returns:
Revision.

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

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

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 75

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 88

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) inherited

src/ol/object.js, line 203

Sets a value.

Name Type Description
key string

Key name.
value *

Value.

setProperties(values) inherited

src/ol/object.js, line 216

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.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 101

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 114

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) inherited

src/ol/object.js, line 229

Unsets a property.

Name Type Description
key string

Key name.