Module: ol/View

ol/View

Classes

View

Type Definitions

Animation{Object}

An animation configuration

Properties:

Name	Type	Argument	Description
`sourceCenter`	module:ol/coordinate~Coordinate	<optional>
`targetCenter`	module:ol/coordinate~Coordinate	<optional>
`sourceResolution`	number	<optional>
`targetResolution`	number	<optional>
`sourceRotation`	number	<optional>
`targetRotation`	number	<optional>
`anchor`	module:ol/coordinate~Coordinate	<optional>
`start`	number
`duration`	number
`complete`	boolean
`easing`	function
`callback`	function

AnimationOptions{Object}

Properties:

Name	Type	Argument	Default	Description
`center`	module:ol/coordinate~Coordinate	<optional>		The center of the view at the end of the animation.
`zoom`	number	<optional>		The zoom level of the view at the end of the animation. This takes precedence over `resolution`.
`resolution`	number	<optional>		The resolution of the view at the end of the animation. If `zoom` is also provided, this option will be ignored.
`rotation`	number	<optional>		The rotation of the view at the end of the animation.
`anchor`	module:ol/coordinate~Coordinate	<optional>		Optional anchor to remained fixed during a rotation or resolution animation.
`duration`	number	<optional>	1000	The duration of the animation in milliseconds.
`easing`	function	<optional>		The easing function used during the animation (defaults to `module: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.

Constraints{Object}

Properties:

Name	Type	Description
`center`	module:ol/centerconstraint~Type
`resolution`	module:ol/resolutionconstraint~Type
`rotation`	module:ol/rotationconstraint~Type

FitOptions{Object}

Properties:

Name	Type	Argument	Default	Description
`size`	module:ol/size~Size	<optional>		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>	<optional>	[0, 0, 0, 0]	Padding (in pixels) to be cleared inside the view. Values in the array are top, right, bottom and left padding.
`constrainResolution`	boolean	<optional>	true	Constrain the resolution.
`nearest`	boolean	<optional>	false	If `constrainResolution` is `true`, get the nearest extent instead of the closest that actually fits the view.
`minResolution`	number	<optional>	0	Minimum resolution that we zoom to.
`maxZoom`	number	<optional>		Maximum zoom level that we zoom to. If `minResolution` is given, this property is ignored.
`duration`	number	<optional>		The duration of the animation in milliseconds. By default, there is no animation to the target extent.
`easing`	function	<optional>		The easing function used during the animation (defaults to `module: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`	function	<optional>		Function called when the view is in its final position. The callback will be called with `true` if the animation series completed on its own or `false` if it was cancelled.

State{Object}

Properties:

Name	Type	Description
`center`	module:ol/coordinate~Coordinate
`projection`	module:ol/proj/Projection~Projection
`resolution`	number
`rotation`	number
`zoom`	number

ViewOptions{Object}

Properties:

Name	Type	Argument	Default	Description
`center`	module:ol/coordinate~Coordinate	<optional>		The initial center for the view. The coordinate system for the center is specified with the `projection` option. Layer sources will not be fetched if this is not set, but the center can be set later with `#setCenter`.
`constrainRotation`	boolean \| number	<optional>	true	Rotation constraint. `false` means no constraint. `true` means no constraint, but snap to zero near zero. A number constrains the rotation to that number of values. For example, `4` will constrain the rotation to 0, 90, 180, and 270 degrees.
`enableRotation`	boolean	<optional>	true	Enable rotation. If `false`, a rotation constraint that always sets the rotation to zero is used. The `constrainRotation` option has no effect if `enableRotation` is `false`.
`extent`	module:ol/extent~Extent	<optional>		The extent that constrains the center, in other words, center cannot be set outside this extent.
`maxResolution`	number	<optional>		The maximum resolution used to determine the resolution constraint. It is used together with `minResolution` (or `maxZoom`) and `zoomFactor`. If unspecified it is calculated in such a way that the projection's validity extent fits in a 256x256 px tile. If the projection is Spherical Mercator (the default) then `maxResolution` defaults to `40075016.68557849 / 256 = 156543.03392804097`.
`minResolution`	number	<optional>		The minimum resolution used to determine the resolution constraint. It is used together with `maxResolution` (or `minZoom`) and `zoomFactor`. If unspecified it is calculated assuming 29 zoom levels (with a factor of 2). If the projection is Spherical Mercator (the default) then `minResolution` defaults to `40075016.68557849 / 256 / Math.pow(2, 28) = 0.0005831682455839253`.
`maxZoom`	number	<optional>	28	The maximum zoom level used to determine the resolution constraint. It is used together with `minZoom` (or `maxResolution`) and `zoomFactor`. Note that if `minResolution` is also provided, it is given precedence over `maxZoom`.
`minZoom`	number	<optional>	0	The minimum zoom level used to determine the resolution constraint. It is used together with `maxZoom` (or `minResolution`) and `zoomFactor`. Note that if `maxResolution` is also provided, it is given precedence over `minZoom`.
`projection`	module:ol/proj~ProjectionLike	<optional>	'EPSG:3857'	The projection. The default is Spherical Mercator.
`resolution`	number	<optional>		The initial resolution for the view. The units are `projection` units per pixel (e.g. meters per pixel). An alternative to setting this is to set `zoom`. Layer sources will not be fetched if neither this nor `zoom` are defined, but they can be set later with `#setZoom` or `#setResolution`.
`resolutions`	Array.<number>	<optional>		Resolutions to determine the resolution constraint. If set the `maxResolution`, `minResolution`, `minZoom`, `maxZoom`, and `zoomFactor` options are ignored.
`rotation`	number	<optional>	0	The initial rotation for the view in radians (positive rotation clockwise, 0 means North).
`zoom`	number	<optional>		Only used if `resolution` is not defined. Zoom level used to calculate the initial resolution for the view. The initial resolution is determined using the `#constrainResolution` method.
`zoomFactor`	number	<optional>	2	The zoom factor used to determine the resolution constraint.