Class: View

Extends

• ol.Object

Observable Properties

Name	Type	Settable	ol.Object.Event 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	yes	change:rotation	The rotation of the view in radians.

Methods

animate(var_args)

src/ol/view.js, line 263

Animate the view. The view's center, zoom (or resolution), and rotation can be animated for smooth transitions between view states. For example, to animate the view to a new zoom level:

view.animate({zoom: view.getZoom() + 1});

By default, the animation lasts one second and uses in-and-out easing. You can customize this behavior by including duration (in milliseconds) and easing options (see ol.easing).

To chain together multiple animations, call the method with multiple animation objects. For example, to first zoom and then pan:

view.animate({zoom: 10}, {center: [0, 0]});

If you provide a function as the last argument to the animate method, it will get called at the end of an animation series. The callback will be called with true if the animation series completed on its own or false if it was cancelled.

Animations are cancelled by user interactions (e.g. dragging the map) or by calling view.setCenter(), view.setResolution(), or view.setRotation() (or another method that calls one of these).

Name	Type	Description
var_args	Animation options. Multiple animations can be run in series by passing multiple options objects. To run multiple animations in parallel, call the method multiple times. An optional callback can be provided as a final argument. The callback will be called with a boolean indicating whether the animation completed without being cancelled. Name Type Description center ol.Coordinate | undefined The center of the view at the end of the animation. zoom number | undefined The zoom level of the view at the end of the animation. This takes precedence over resolution. resolution number | undefined The resolution of the view at the end of the animation. If zoom is also provided, this option will be ignored. rotation number | undefined The rotation of the view at the end of the animation. anchor ol.Coordinate | undefined Optional anchor to remained fixed during a rotation or resolution animation. duration number | undefined The duration of the animation in milliseconds (defaults to 1000). easing undefined | function The easing function used during the animation (defaults to ol.easing.inAndOut). The function will be called for each frame with a number representing a fraction of the animation's duration. The function should return a number between 0 and 1 representing the progress toward the destination state.

calculateExtent(opt_size){ol.Extent}

src/ol/view.js, line 598

Calculate the extent for the current view state and the passed size. The size is the pixel dimensions 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. If not provided, the size of the first map that uses this view will be used.

Returns:

Extent.

cancelAnimations()

src/ol/view.js, line 368

Cancel any ongoing animations.

centerOn(coordinate, size, position)

src/ol/view.js, line 964

Center on coordinate and view position.

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

changed() inherited

src/ol/observable.js, line 58

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

constrainCenter(center){ol.Coordinate|undefined}

src/ol/view.js, line 519

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}

src/ol/view.js, line 532

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}

src/ol/view.js, line 547

Get the constrained rotation of this view.

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

Returns:

Constrained rotation.

dispatchEvent(event) inherited

src/ol/observable.js, line 75

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name	Type	Description
event	Object | ol.events.Event | string	Event object.

fit(geometryOrExtent, opt_options)

src/ol/view.js, line 861

Fit the given geometry or extent based on the given map size and border. The size is pixel dimensions of the box to fit the extent into. In most cases you will want to use the map size, that is map.getSize(). Takes care of the map angle.

Name	Type	Description
geometryOrExtent	ol.geom.SimpleGeometry | ol.Extent	The geometry or extent to fit the view to.
options	Options. Name Type Description size ol.Size | undefined The size in pixels of the box to fit the extent into. Default is the current size of the first map in the DOM that uses this view, or [100, 100] if no such map is found. padding !Array.<number> | undefined 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. maxZoom number | undefined Maximum zoom level that we zoom to. If minResolution is given, this property is ignored. duration number | undefined The duration of the animation in milliseconds. By default, there is no animations. easing undefined | function The easing function used during the animation (defaults to ol.easing.inAndOut). The function will be called for each frame with a number representing a fraction of the animation's duration. The function should return a number between 0 and 1 representing the progress toward the destination state. callback undefined | function Optional function called when the view is in it's final position. The callback will be called with true if the animation series completed on its own or false if it was cancelled.

get(key){*} inherited

src/ol/object.js, line 101

Gets a value.

Name	Type	Description
key	string	Key name.

Returns:

Value.

getAnimating(){boolean}

src/ol/view.js, line 349

Determine if the view is being animated.

Returns:

The view is being animated.

getCenter(){ol.Coordinate|undefined}

src/ol/view.js, line 559

Get the view center.

Returns:

The center of the view.

getInteracting(){boolean}

src/ol/view.js, line 359

Determine if the user is interacting with the view, such as panning or zooming.

Returns:

The view is being interacted with.

getKeys(){Array.<string>} inherited

src/ol/object.js, line 115

Get a list of object property names.

Returns:

List of property names.

getMaxResolution(){number}

src/ol/view.js, line 616

Get the maximum resolution of the view.

Returns:

The maximum resolution of the view.

getMaxZoom(){number}

src/ol/view.js, line 636

Get the maximum zoom level for the view.

Returns:

The maximum zoom level.

getMinResolution(){number}

src/ol/view.js, line 626

Get the minimum resolution of the view.

Returns:

The minimum resolution of the view.

getMinZoom(){number}

src/ol/view.js, line 656

Get the minimum zoom level for the view.

Returns:

The minimum zoom level.

getProjection(){ol.proj.Projection}

src/ol/view.js, line 676

Get the view projection.

Returns:

The projection of the view.

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

src/ol/object.js, line 125

Get an object of all property names and values.

Returns:

Object.

getResolution(){number|undefined}

src/ol/view.js, line 687

Get the view resolution.

Returns:

The resolution of the view.

getResolutionForExtent(extent, opt_size){number}

src/ol/view.js, line 712

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.

getResolutionForZoom(zoom){number}

src/ol/view.js, line 845

Get the resolution for a zoom level.

Name	Type	Description
zoom	number	Zoom level.

Returns:

The view resolution for the provided zoom level.

getResolutions(){Array.<number>|undefined}

src/ol/view.js, line 699

Get the resolutions for the view. This returns the array of resolutions passed to the constructor of the {ol.View}, or undefined if none were given.

Returns:

The resolutions of the view.

getRevision(){number} inherited

src/ol/observable.js, line 84

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:

Revision.

getRotation(){number}

src/ol/view.js, line 749

Get the view rotation.

Returns:

The rotation of the view in radians.

getZoom(){number|undefined}

src/ol/view.js, line 803

Get the current zoom level. If you configured your view with a resolutions array (this is rare), this method may return non-integer zoom levels (so the zoom level is not safe to use as an index into a resolutions array).

Returns:

Zoom.

getZoomForResolution(resolution){number|undefined}

src/ol/view.js, line 819

Get the zoom level for a resolution.

Name	Type	Description
resolution	number	The resolution.

Returns:

The zoom level for the provided resolution.

on(type, listener, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited

src/ol/observable.js, line 99

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. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited

src/ol/observable.js, line 124

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. If called with an array of event types as the first argument, the return will be an array of keys.

rotate(rotation, opt_anchor)

src/ol/view.js, line 998

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, opt_silent) inherited

src/ol/object.js, line 150

Sets a value.

Name	Type	Description
key	string	Key name.
value	*	Value.
silent	boolean	Update without triggering an event.

setCenter(center)

src/ol/view.js, line 1013

Set the center of the current view.

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

setMaxZoom(zoom)

src/ol/view.js, line 646

Set a new maximum zoom level for the view.

Name	Type	Description
zoom	number	The maximum zoom level.

setMinZoom(zoom)

src/ol/view.js, line 666

Set a new minimum zoom level for the view.

Name	Type	Description
zoom	number	The minimum zoom level.

setProperties(values, opt_silent) inherited

src/ol/object.js, line 170

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.
silent	boolean	Update without triggering an event.

setResolution(resolution)

src/ol/view.js, line 1039

Set the resolution for this view.

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

setRotation(rotation)

src/ol/view.js, line 1053

Set the rotation for this view.

Name	Type	Description
rotation	number	The rotation of the view in radians.

setZoom(zoom)

src/ol/view.js, line 1066

Zoom to a specific zoom level.

Name	Type	Description
zoom	number	Zoom level.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 147

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.

unset(key, opt_silent) inherited

src/ol/object.js, line 184

Unsets a property.

Name	Type	Description
key	string	Key name.
silent	boolean	Unset without triggering an event.