Class: View2D

Extends

• ol.IView2D
• ol.IView3D
• ol.View

Observable Properties

Name	Type	Settable	ol.ObjectEvent type	Description
center	ol.Coordinate | undefined	yes	change:center	The center of the view.
projection	ol.proj.Projection | undefined	yes	change:projection	The projection of the view.
resolution	number | undefined	yes	change:resolution	The resolution of the view.
rotation	number | undefined	yes	change:rotation	The rotation of the view.

Methods

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

src/ol/object.js, line 247

The bindTo method allows you to set up a two-way binding between a source and target object. The method returns an ol.ObjectAccessor with a transform method that lets you 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	Argument	Description
key	string		Key name.
target	ol.Object		Target.
targetKey	string	<optional>	optional Target key.

experimental calculateExtent(size){ol.Extent}

src/ol/view2d.js, line 240

Calculate the extent for the given size in pixels, based on the current resolution and the current center.

Name	Type	Description
size	ol.Size	Box pixel size.

experimental centerOn(coordinate, size, position)

src/ol/view2d.js, line 513

Center on coordinate and view position. Take care on the map angle.

Name	Type	Description
coordinate	ol.Coordinate	Coordinate.
size	ol.Size	Box pixel size.
position	ol.Pixel	Position on the view to center on.

experimental constrainResolution(resolution, opt_delta, opt_direction){number|undefined}

src/ol/view2d.js, line 197

Get the constrained the resolution of this view.

Name	Type	Argument	Description
resolution	number | undefined		Resolution.
delta	number	<optional>	optional Delta. Default is 0.
direction	number	<optional>	optional Direction. Default is 0.

Returns:

resolution.

experimental constrainRotation(rotation, opt_delta){number|undefined}

src/ol/view2d.js, line 212

Get the constrained rotation of this view.

Name	Type	Argument	Description
rotation	number | undefined		Rotation.
delta	number	<optional>	optional Delta. Default is 0.

Returns:

rotation.

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 fitExtent(extent, size)

src/ol/view2d.js, line 424

Fit the given extent based on the given map size.

Name	Type	Description
extent	ol.Extent	Extent.
size	ol.Size	Box pixel size.

experimental fitGeometry(geometry, size, opt_options)

src/ol/view2d.js, line 446

Fit the given geometry based on the given map size and border. Take care on the map angle.

Name	Type	Argument	Description
geometry	ol.geom.SimpleGeometry		Geometry.
size	ol.Size		Box pixel size.
options	optional Options. Name Type Description padding !Array.<number> Padding (in pixels) to be cleared inside the view. Values in the array are top, right, bottom and left padding. Default is [0, 0, 0, 0]. constrainResolution boolean | undefined Constrain the resolution. Default is true. nearest boolean | undefined Get the nearest extent. Default is false. minResolution number | undefined Minimum resolution that we zoom to. Default is 0.

experimental inherited get(key){*}

src/ol/object.js, line 304

Gets a value.

Name	Type	Description
key	string	Key name.

experimental getCenter(){ol.Coordinate|undefined}

src/ol/view2d.js, line 223

Returns:

center of the view.

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

src/ol/object.js, line 332

Get a list of object property names.

Returns:

of property names.

experimental getProjection(){ol.proj.Projection|undefined}

src/ol/view2d.js, line 257

Returns:

projection of the view.

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

src/ol/object.js, line 364

Get an object of all property names and values.

experimental getResolution(){number|undefined}

src/ol/view2d.js, line 272

Returns:

resolution of the view.

experimental getRotation(){number|undefined}

src/ol/view2d.js, line 324

Returns:

rotation of the view.

experimental getView2D(){ol.IView2D}

src/ol/view2d.js, line 362

experimental getZoom(){number|undefined}

src/ol/view2d.js, line 398

Get the current zoom level. Return undefined if the current resolution is undefined or not a "constrained resolution".

experimental inherited notify(key)

src/ol/object.js, line 384

Notify all observers of a change on this property. This notifies both objects that are bound to the object's property as well as the object that it is bound to.

Name	Type	Description
key	string	Key name.

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 rotate(rotation, opt_anchor)

src/ol/view2d.js, line 548

Rotate the view around a given coordinate.

Name	Type	Argument	Description
rotation	number		New rotation value for the view.
anchor	ol.Coordinate	<optional>	optional The rotation center.

experimental inherited set(key, value)

src/ol/object.js, line 415

Sets a value.

Name	Type	Description
key	string	Key name.
value	*	Value.

experimental setCenter(center)

src/ol/view2d.js, line 563

Set the center of the current view.

Name	Type	Description
center	ol.Coordinate | undefined	The center of the view.

experimental setProjection(projection)

src/ol/view2d.js, line 579

Set the projection of this view. Warning! This code is not yet implemented. Function should not be used.

Name	Type	Description
projection	ol.proj.Projection | undefined	The projection of the view.

experimental setResolution(resolution)

src/ol/view2d.js, line 594

Set the resolution for this view.

Name	Type	Description
resolution	number | undefined	The resolution of the view.

experimental setRotation(rotation)

src/ol/view2d.js, line 609

Set the rotation for this view.

Name	Type	Description
rotation	number | undefined	The rotation of the view.

experimental inherited setValues(values)

src/ol/object.js, line 444

Sets a collection of key-value pairs.

Name	Type	Description
values	Object.<string, *>	Values.

experimental setZoom(zoom)

src/ol/view2d.js, line 623

Zoom to a specific zoom level.

Name	Type	Description
zoom	number	Zoom level.

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 unbind(key)

src/ol/object.js, line 458

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.

experimental inherited unbindAll()

src/ol/object.js, line 482

Removes all bindings.

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.