OpenLayers 3

Class: ImageCanvas

ol.source.ImageCanvas

Base class for image sources where a canvas element is the image.

new ol.source.ImageCanvas(options) experimental

src/ol/source/imagecanvassource.js, line 19
Name Type Description
options
Name Type Description
attributions Array.<ol.Attribution> | undefined experimental

Attributions.
canvasFunction ol.CanvasFunctionType experimental

Canvas function. The function returning the canvas element used by the source as an image. The arguments passed to the function are: {ol.Extent} the image extent, {number} the image resolution, {number} the device pixel ratio, {ol.Size} the image size, and {ol.proj.Projection} the image projection. The canvas returned by this function is cached by the source. If the value returned by the function is later changed then dispatchChangeEvent should be called on the source for the source to invalidate the current cached image.
logo string | olx.LogoOptions | undefined experimental

Logo.
projection ol.proj.ProjectionLike experimental

Projection.
ratio number | undefined experimental

Ratio. 1 means canvases are the size of the map viewport, 2 means twice the size of the map viewport, and so on. Default is 1.5.
resolutions Array.<number> | undefined experimental

Resolutions. If specified, new canvases will be created for these resolutions only.
state ol.source.State | string | undefined experimental

Source state.
Fires:
  • change experimental - Triggered when the state of the source changes.
  • propertychange (ol.ObjectEvent) - Triggered when a property is changed.

Subclasses

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.