Class: View

Extends

• ol.Object

Observable Properties

Name	Type	Settable	ol.ObjectEvent type	Description
center	ol.Coordinate | undefined	yes	change:center	The center 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

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

src/ol/object.js, line 301

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.

calculateExtent(size){ol.Extent} experimental

src/ol/view.js, line 271

Calculate the extent for the current view state and the passed size. size is the size in pixels of the box into which the calculated extent should fit. In most cases you want to get the extent of the entire map, that is map.getSize().

Name	Type	Description
size	ol.Size	Box pixel size.

Returns:

Extent.

centerOn(coordinate, size, position) experimental

src/ol/view.js, line 534

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.

constrainCenter(center){ol.Coordinate|undefined} experimental

src/ol/view.js, line 205

Get the constrained center of this view.

Name	Type	Description
center	ol.Coordinate | undefined	Center.

Returns:

Constrained center.

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

src/ol/view.js, line 218

Get the constrained resolution of this view.

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

Returns:

Constrained resolution.

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

src/ol/view.js, line 233

Get the constrained rotation of this view.

Name	Type	Description
rotation	number | undefined	Rotation.
delta	number	Delta. Default is 0.

Returns:

Constrained rotation.

dispatchChangeEvent() inherited experimental

src/ol/observable.js, line 42

Dispatches a change event.

Fires:

• change experimental

fitExtent(extent, size) experimental

src/ol/view.js, line 438

Fit the map view to the passed extent and size. size is the size in pixels of the box to fit the extent into. In most cases you will want to use the map size, that is map.getSize().

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

fitGeometry(geometry, size, opt_options) experimental

src/ol/view.js, line 460

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

Name	Type	Description
geometry	ol.geom.SimpleGeometry	Geometry.
size	ol.Size	Box pixel size.
options	Options. Name Type Description padding Array.<number> experimental 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 experimental Constrain the resolution. Default is true. nearest boolean | undefined experimental Get the nearest extent. Default is false. minResolution number | undefined experimental Minimum resolution that we zoom to. Default is 0. maxZoom number | undefined experimental Maximum zoom level that we zoom to. If minResolution is given, this property is ignored.

get(key){*} inherited experimental

src/ol/object.js, line 358

Gets a value.

Name	Type	Description
key	string	Key name.

Returns:

Value.

getCenter(){ol.Coordinate|undefined}

src/ol/view.js, line 244

Returns:

The center of the view.

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

src/ol/object.js, line 386

Get a list of object property names.

Returns:

List of property names.

getProjection(){ol.proj.Projection}

src/ol/view.js, line 287

Returns:

The projection of the view.

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

src/ol/object.js, line 418

Get an object of all property names and values.

Returns:

Object.

getResolution(){number|undefined}

src/ol/view.js, line 297

Returns:

The resolution of the view.

getResolutionForExtent(extent, size){number} experimental

src/ol/view.js, line 315

Get the resolution for a provided extent (in map units) and size (in pixels).

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

Returns:

The resolution at which the provided extent will render at the given size.

getRevision(){number} inherited experimental

src/ol/observable.js, line 52

Returns:

Revision.

getRotation(){number|undefined}

src/ol/view.js, line 352

Returns:

The rotation of the view.

getZoom(){number|undefined}

src/ol/view.js, line 410

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

Returns:

Zoom.

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

src/ol/observable.js, line 65

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 78

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.

rotate(rotation, opt_anchor)

src/ol/view.js, line 569

Rotate the view around a given coordinate.

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

set(key, value) inherited experimental

src/ol/object.js, line 448

Sets a value.

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

setCenter(center)

src/ol/view.js, line 584

Set the center of the current view.

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

setProperties(values) inherited experimental

src/ol/object.js, line 477

Sets a collection of key-value pairs.

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

setResolution(resolution)

src/ol/view.js, line 612

Set the resolution for this view.

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

setRotation(rotation)

src/ol/view.js, line 627

Set the rotation for this view.

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

setZoom(zoom)

src/ol/view.js, line 641

Zoom to a specific zoom level.

Name	Type	Description
zoom	number	Zoom level.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 91

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 491

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 515

Removes all bindings.

unByKey(key) inherited

src/ol/observable.js, line 101

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

Name	Type	Description
key	goog.events.Key	Key.