OpenLayers 3 API Documentation

Class: ImageVector

ol.source. ImageVector

experimental new ol.source.ImageVector(options)

src/ol/source/imagevectorsource.js, line 34

An image source whose images are canvas elements into which vector features read from a vector source (ol.source.Vector) are drawn. An ol.source.ImageVector object is to be used as the source of an image layer (ol.layer.Image). Image layers are rotated, scaled, and translated, as opposed to being re-rendered, during animations and interactions. So, like any other image layer, an image layer configured with an ol.source.ImageVector will exhibit this behaviour. This is in contrast to a vector layer, where vector features are re-drawn during animations and interactions.

Name Type Description
options

Options.

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

Attributions.
extent ol.Extent | undefined

Extent.
logo string | undefined

Logo.
projection ol.proj.ProjectionLike

Projection.
ratio number | undefined

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

Resolutions. If specified, new canvases will be created for these resolutions only.
source ol.source.Vector

The vector source from which the vector features drawn in canvas elements are read.
style ol.style.Style | Array.<ol.style.Style> | ol.feature.StyleFunction | undefined

Style to use when rendering features to the canvas.
Fires:
  • change

Extends

Methods

experimental inherited dispatchChangeEvent()

src/ol/observable.js, line 39

Dispatches a change event. Register a listener for this event to get notified of changes.

Fires:
  • change

experimental getSource(){ol.source.Vector}

src/ol/source/imagevectorsource.js, line 170

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

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

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

src/ol/observable.js, line 61

Listen for a certain type of event.

Name Type Argument Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object <optional>
 optional

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

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

src/ol/observable.js, line 74

Listen once for a certain type of event.

Name Type Argument Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object <optional>
 optional

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

experimental inherited un(type, listener, opt_this)

src/ol/observable.js, line 86

Unlisten for a certain type of event.

Name Type Argument Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object <optional>
 optional

The object to use as this in listener.

experimental inherited unByKey(key)

src/ol/observable.js, line 96

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

Name Type Description
key goog.events.Key

Key.