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	yes	change:rotation	The rotation of the view in radians.

Methods

calculateExtent(size){ol.Extent}

src/ol/view.js, line 286

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.

Returns:

Extent.

centerOn(coordinate, size, position) experimental

src/ol/view.js, line 551

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 experimental

src/ol/observable.js, line 57

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

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

src/ol/view.js, line 216

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 229

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 244

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 experimental

src/ol/observable.js, line 81

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(geometry, size, opt_options) experimental

src/ol/view.js, line 470

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
geometry	ol.geom.SimpleGeometry | ol.Extent	Geometry.
size	ol.Size	Box pixel size.
options	Options. Name Type Description padding !Array.<number> | undefined 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

src/ol/object.js, line 148

Gets a value.

Name	Type	Description
key	string	Key name.

Returns:

Value.

getCenter(){ol.Coordinate|undefined}

src/ol/view.js, line 256

Get the view center.

Returns:

The center of the view.

getKeys(){Array.<string>} inherited

src/ol/object.js, line 162

Get a list of object property names.

Returns:

List of property names.

getProjection(){ol.proj.Projection}

src/ol/view.js, line 305

Get the view projection.

Returns:

The projection of the view.

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

src/ol/object.js, line 172

Get an object of all property names and values.

Returns:

Object.

getResolution(){number|undefined}

src/ol/view.js, line 316

Get the view resolution.

Returns:

The resolution of the view.

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

src/ol/view.js, line 328

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 experimental

src/ol/observable.js, line 90

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 380

Get the view rotation.

Returns:

The rotation of the view in radians.

getZoom(){number|undefined}

src/ol/view.js, line 440

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){ol.events.Key|Array.<ol.events.Key>} inherited

src/ol/observable.js, line 105

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.events.Key|Array.<ol.events.Key>} inherited

src/ol/observable.js, line 130

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 585

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 197

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 600

Set the center of the current view.

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

setProperties(values, opt_silent) inherited

src/ol/object.js, line 217

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 626

Set the resolution for this view.

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

setRotation(rotation)

src/ol/view.js, line 637

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 647

Zoom to a specific zoom level.

Name	Type	Description
zoom	number	Zoom level.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 153

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.

unByKey(key) inherited

src/ol/observable.js, line 174

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	ol.events.Key | Array.<ol.events.Key>	The key returned by on() or once() (or an array of keys).

unset(key, opt_silent) inherited

src/ol/object.js, line 231

Unsets a property.

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