OpenLayers 3 API Documentation - Namespace: ol.animation

The {ol.animation} static methods are designed to be used with the ol.Map#beforeRender method. For example:

var map = new ol.Map({ ... });
var zoom = ol.animation.zoom({
  resolution: map.getView().getResolution()
});
map.beforeRender(zoom);
map.getView().setResolution(map.getView().getResolution() * 2);

Source:

animation.jsdoc, line 1

Methods

<static> bounce

Parameters:

Name	Type	Description
`options`	ol.animation.BounceOptions	Bounce options.

Source:

animation.js, line 14

Returns:

Pre-render function.

Type: ol.PreRenderFunction

<static> pan

Parameters:

Name	Type	Description
`options`	ol.animation.PanOptions	Pan options.

Source:

animation.js, line 48

Returns:

Pre-render function.

Type: ol.PreRenderFunction

<static> rotate

Parameters:

Name	Type	Description
`options`	ol.animation.RotateOptions	Rotate options.

Source:

animation.js, line 86

Returns:

Pre-render function.

Type: ol.PreRenderFunction

<static> zoom

Parameters:

Name	Type	Description
`options`	ol.animation.ZoomOptions	Zoom options.

Source:

animation.js, line 122

Returns:

Pre-render function.

Type: ol.PreRenderFunction

TypeDefs

BounceOptions

Properties:

Name	Type	Description
`resolution`	number	The resolution to start the bounce from, typically `map.getView().getResolution()`.
`start`	number \| undefined	The start time of the animation. Default is immediately.
`duration`	number \| undefined	The duration of the animation in milliseconds. Default is 1000.
`easing`	function	The easing function to use. Default is `ol.easing.upAndDown`

Source:

objectliterals.jsdoc, line 21

PanOptions

Properties:

Name	Type	Description
`source`	ol.Coordinate	The location to start panning from, typically `map.getView().getCenter()`.
`start`	number \| undefined	The start time of the animation. Default is immediately.
`duration`	number \| undefined	The duration of the animation in milliseconds. Default is 1000.
`easing`	function	The easing function to use. Default is `ol.easing.inAndOut`

Source:

objectliterals.jsdoc, line 23

RotateOptions

Properties:

Name	Type	Description
`rotation`	number	The rotation to apply, in radians.
`start`	number \| undefined	The start time of the animation. Default is immediately.
`duration`	number \| undefined	The duration of the animation in milliseconds. Default is 1000.
`easing`	function	The easing function to use. Default is `ol.easing.inAndOut`

Source:

objectliterals.jsdoc, line 25

ZoomOptions

Properties:

Name	Type	Description
`resolution`	number	number The resolution to begin zooming from, typically `map.getView().getResolution()`.
`start`	number \| undefined	The start time of the animation. Default is immediately.
`duration`	number \| undefined	The duration of the animation in milliseconds.
`easing`	function	Easing function.

Source:

objectliterals.jsdoc, line 27