Class: ImageVector

ol.source.ImageVector

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.

new ol.source.ImageVector(options) experimental

src/ol/source/imagevectorsource.js, line 35
Name Type Description
options

Options.

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

Attributions.

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.

source ol.source.Vector experimental

The vector source from which the vector features drawn in canvas elements are read.

style ol.style.Style | Array.<ol.style.Style> | ol.style.StyleFunction | undefined experimental

Style to use when rendering features to the canvas.

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

Extends

Methods

bindTo(key, target, opt_targetKey){ol.ObjectAccessor} inherited experimental

src/ol/object.js, line 326

The bindTo method allows you to set up a two-way binding between a source and target object. The method returns an object with a transform method that you can use to provide from and to functions to transform values on the way from the source to the target and on the way back.

For example, if you had two map views (sourceView and targetView) and you wanted the target view to have double the resolution of the source view, you could transform the resolution on the way to and from the target with the following:

sourceView.bindTo('resolution', targetView)
  .transform(
    function(sourceResolution) {
      // from sourceView.resolution to targetView.resolution
      return 2 * sourceResolution;
    },
    function(targetResolution) {
      // from targetView.resolution to sourceView.resolution
      return targetResolution / 2;
    }
  );
Name Type Description
key string

Key name.

target ol.Object

Target.

targetKey string

Target key.

changed() inherited experimental

src/ol/observable.js, line 52

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

Fires:
  • change experimental

get(key){*} inherited experimental

src/ol/object.js, line 354

Gets a value.

Name Type Description
key string

Key name.

Returns:
Value.

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

src/ol/source/source.js, line 96
Returns:
Attributions.

getKeys(){Array.<string>} inherited experimental

src/ol/object.js, line 373

Get a list of object property names.

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

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

src/ol/source/source.js, line 114
Returns:
Projection.

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

src/ol/object.js, line 405

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited experimental

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

getSource(){ol.source.Vector} experimental

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

Get a reference to the wrapped source.

Returns:
Source.

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

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

getStyle(){ol.style.Style|Array.<ol.style.Style>|ol.style.StyleFunction}

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

Get the style for features. This returns whatever was passed to the style option at construction or to the setStyle method.

Returns:
Layer style.

getStyleFunction(){ol.style.StyleFunction|undefined}

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

Get the style function.

Returns:
Layer style function.

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 experimental

src/ol/object.js, line 437

Sets a value.

Name Type Description
key string

Key name.

value *

Value.

setProperties(values) inherited experimental

src/ol/object.js, line 456

Sets a collection of key-value pairs.

Name Type Description
values Object.<string, *>

Values.

setStyle(style)

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

Set the style for features. This can be a single style object, an array of styles, or a function that takes a feature and resolution and returns an array of styles. If it is undefined the default style is used. If it is null the layer has no style (a null style), so only features that have their own styles will be rendered in the layer. See ol.style for information on the default style.

Name Type Description
style ol.style.Style | Array.<ol.style.Style> | ol.style.StyleFunction | undefined

Layer style.

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.

unbind(key) inherited experimental

src/ol/object.js, line 470

Removes a binding. Unbinding will set the unbound property to the current value. The object will not be notified, as the value has not changed.

Name Type Description
key string

Key name.

unbindAll() inherited experimental

src/ol/object.js, line 487

Removes all bindings.

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().