类：视图

ol/View~视图

import View from 'ol/View.js';

视图对象表示地图的简单二维视图。

这是用于调整地图中心、分辨率和旋转的对象。

视图包含一个 projection。投影决定了中心的坐标系，其单位决定了分辨率的单位（即每像素对应的投影单位数）。默认投影为 Web 墨卡托 (EPSG:3857)。

视图状态

视图由三个状态确定：center、resolution 和 rotation。每个状态都提供相应的 getter 和 setter，例如，getCenter 和 setCenter 分别对应 center 状态。

zoom 状态实际上并未在视图上保存：所有内部计算均使用 resolution 状态。尽管如此，setZoom 和 getZoom 方法仍然可用，同时 getResolutionForZoom 和 getZoomForResolution 也可用于在两个系统间切换。

约束条件

setCenter、setResolution 和 setRotation 可用于修改视图的状态，但构造函数中定义的任何约束均会在操作过程中生效。

视图对象可以包括中心（分辨率约束）、缩放（旋转约束）和旋转（中心约束）。

视图（分辨率约束）通常限制最小/最大值并吸附至特定分辨率。其由以下选项确定：resolutions、maxResolution、maxZoom 和 zoomFactor。若设置了 resolutions，则其他三个选项将被忽略。更多信息请参阅各选项的文档。默认情况下，视图（分辨率约束）仅设有最小/最大限制，例如在捏合缩放时允许中间缩放级别。

旋转控件（旋转约束）支持捕捉到特定角度。该功能由 enableRotation 和 constrainRotation 选项配置。默认情况下，允许旋转，且当角度接近水平时，其值会自动捕捉到零度。

视图中心（中心约束）由 extent 选项决定。默认情况下，视图中心完全不受约束。

更改视图状态

需注意，setZoom、setResolution、setCenter 及 setRotation 受上述约束限制。因此，视图的最终状态有时可能无法预先确定。例如，调用 setResolution(10) 并不保证 getResolution() 会返回 10。

因此，对视图状态应用增量时，应使用 adjustCenter、adjustRotation、adjustZoom 和 adjustResolution，而非对应的设置器。这将使视图执行其内部计算。此外，adjust* 方法还接受一个 anchor 参数，用于指定变换的原点。

视图交互

视图约束通常仅在视图处于静止状态状态时应用，这意味着没有交互或动画正在进行。因此，如果用户将视图置于一个不等同于约束状态的状态（例如，当捕捉角度为0时旋转视图），则在交互结束时将触发一个动画，将视图恢复到稳定状态；

new View(options) View.js, line 313

Name	Type	描述
`center`	Coordinate \| undefined	视图的初始中心坐标。若未设置用户投影，则中心坐标系由`projection`若未设置此选项，则不会加载图层数据源，但地图中心可在之后设置。`#setCenter`.
`constrainRotation`	boolean \| number (defaults to true)	旋转约束。`false`表示无约束。`true`表示无约束，但会吸附到零附近。一个数值将旋转限制为指定数量的离散值。例如，`4`将旋转限制为0度、90度、180度和270度。
`enableRotation`	boolean (defaults to true)	启用旋转。如果`false`，采用一个始终将旋转锁定为零的旋转约束。这`constrainRotation`若...，则该选项无效`enableRotation`是`false`.
`extent`	Extent \| undefined	约束视图的范围，换句话说，超出该范围的内容在地图上均不可见。
`constrainOnlyCenter`	boolean (defaults to false)	当设置为 true 时，范围约束仅适用于视图中心，而不适用于整个范围。
`smoothExtentConstraint`	boolean (defaults to true)	若为 True，范围约束将平滑应用，即允许视图略微超出指定范围。`extent`.
`maxResolution`	number \| undefined	用于定义分辨率约束的最大分辨率。它常与其他参数一起使用。`minResolution`（或者`maxZoom`）和`zoomFactor`若未指定，则计算方式确保投影的有效范围适配于一个 256x256 像素的瓦片。如果投影是球面墨卡托投影（默认），则`maxResolution`默认为`40075016.68557849 / 256 = 156543.03392804097`.
`minResolution`	number \| undefined	用于确定分辨率约束的最小分辨率值。它与其他参数一起使用。`maxResolution`（或`minZoom`）和`zoomFactor`如果未指定，则假定缩放级别为29（缩放因子为2）进行计算。如果投影为球面墨卡托投影（默认），则`minResolution`默认为`40075016.68557849 / 256 / Math.pow(2, 28) = 0.0005831682455839253`.
`maxZoom`	number (defaults to 28)	用于确定分辨率约束的最大缩放级别。该级别与...一起使用。`minZoom`（或`maxResolution`）和`zoomFactor`。请注意，如果`minResolution`还提供了，它优先于`maxZoom`.
`minZoom`	number (defaults to 0)	用于确定分辨率约束的最小缩放级别。它常与另一缩放级别配合使用。`maxZoom`（或者`minResolution`）和`zoomFactor`请注意，如果`maxResolution`它还提供，并优先于`minZoom`.
`multiWorld`	boolean (defaults to false)	如果`false`视图受限，因此只有一个世界可见，且无法平移超出边界。如果`true`地图在低缩放级别下可能会显示多个世界副本。仅在以下情况下使用`projection`是全局的。请注意，如果`extent`若赋予优先权，则也提供。
`constrainResolution`	boolean (defaults to false)	若为 true，交互后的视图将始终动画到最近的缩放级别；若为 false，则允许中间缩放级别。
`smoothResolutionConstraint`	boolean (defaults to true)	若为真，则平滑应用分辨率的最小值和最大值，即允许视图略微超出指定的分辨率或缩放边界。
`showFullExtent`	boolean (defaults to false)	允许缩小视图以完整显示配置的范围。默认情况下，若视图配置了范围，则禁止用户缩小，以确保视口在任意维度上均不超出该范围。这意味着，当视口的纵横比与配置范围的纵横比不一致时，完整范围可能无法完全显示。若 showFullExtent 为 true，用户可缩小视图，使视口在高度或宽度上超出配置范围，但不可同时超出两者，以确保完整范围得以显示。
`projection`	ProjectionLike (defaults to 'EPSG:3857')	投影设置。默认采用球面墨卡托投影。
`resolution`	number \| undefined	视图的初始分辨率。其单位是`projection`每像素单位（例如米每像素）。设置此参数的另一种方法是设置`zoom`如果既没有这个也没有，则不会加载图层源`zoom`已定义，但可稍后设置。`#setZoom`或`#setResolution`.
`resolutions`	Array.<number> \| undefined	用于定义缩放级别的分辨率（若已指定）。数组中索引值对应缩放级别，因此分辨率需按降序排列。该参数同时通过最小值和最大值约束分辨率范围。若已设置该参数`maxResolution`, `minResolution`, `minZoom`, `maxZoom`，和`zoomFactor`选项将被忽略。
`rotation`	number (defaults to 0)	视图的初始旋转角度（弧度制），顺时针方向为正，0 对应正北。
`zoom`	number \| undefined	仅在以下情况下使用`resolution`未定义。用于计算视图初始分辨率的缩放级别。
`zoomFactor`	number (defaults to 2)	用于计算相应分辨率的缩放因子。
`padding`	Array.<number> (defaults to [0, 0, 0, 0])	填充（以 CSS 像素为单位）。如果地图视口的边缘部分被其他内容（覆盖物）遮挡，此设置允许将视口中心偏移以避开这些内容。值的顺序为：上、右、下、左。

触发事件：

change （基础事件（BaseEvent）） - 通用更改事件。当修订计数器增加时触发。
change:center (ObjectEvent)
change:resolution (ObjectEvent)
change:rotation (ObjectEvent)
error (BaseEvent基础事件) - 通用错误事件。在发生错误时触发。
propertychange ObjectEvent对象事件 - 当属性更改时触发。

继承

BaseObject

可观察属性

Name	Type	可设置	ObjectEvent type	描述
`center`	Coordinate \| undefined	是的	`change:center`	视图中心。
`resolution`	number \| undefined	是的	`change:resolution`	视图分辨率。
`rotation`	number	是的	`change:rotation`	视图旋转（弧度）

成员

padding{Array.<number>} {undefined}

填充（以 CSS 像素为单位）。如果地图视口的边缘部分被其他内容（覆盖层）覆盖，此设置允许将视口中心偏移以避开该内容。数组中值的顺序为上、右、下、左。默认为无填充，相当于 [0, 0, 0, 0]。

方法

adjustCenter(deltaCoordinates) View.js, line 1545

在视图中心添加相对坐标。任何范围约束均将生效。

Name	Type	描述
`deltaCoordinates`	Coordinate	待添加的相对值。

adjustResolution(ratio, anchor) View.js, line 1572

将视图分辨率按比例缩放，可选用锚点。任何分辨率约束均将生效。

Name	Type	描述
`ratio`	number	应用于视图分辨率的比率。
`anchor`	Coordinate \| undefined	变换的起源。

adjustRotation(delta, anchor) View.js, line 1619

为视图旋转增加一个值，可选择使用锚点。任何旋转约束均将适用。

Name	Type	描述
`delta`	number	添加到视图旋转的相对值（以弧度为单位）。
`anchor`	Coordinate \| undefined	旋转中心。

adjustZoom(delta, anchor) View.js, line 1608

向视图缩放级别添加一个值（可选使用锚点）。任何分辨率约束均将适用。

Name	Type	描述
`delta`	number	要添加到缩放级别的相对值
`anchor`	Coordinate \| undefined	变换的起源。

animate(var_args) View.js, line 587

动画视图。视图的中心、缩放（或分辨率）和旋转可以动画化，以实现视图状态间的平滑过渡。例如，要将视图动画化到新的缩放级别：

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

默认情况下，动画持续时间为1秒，并采用缓入缓出效果。您可以通过指定 duration（毫秒）和 easing 选项来自定义此行为（参见 ol/easing）。

要将多个动画进行链式组合，请调用方法并传入多个动画对象。例如，先缩放后平移：

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

若将函数作为 animate 方法的最后一个参数传入，该函数将在动画序列结束时被触发。回调函数将根据动画序列的完成状态被调用：若序列自然结束，则使用 true；若被取消，则使用 false。

动画可通过用户交互（如拖动地图）或调用 view.setCenter()、view.setResolution() 或 view.setRotation()（或调用这些方法之一的其他方法）来取消。

Name Type 描述

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	描述
`center`	Coordinate \| undefined	动画结束时视图的中心。
`zoom`	number \| undefined	动画结束时的视图缩放级别。其优先级高于`resolution`.
`resolution`	number \| undefined	动画结束时的视图分辨率。如果`zoom`若同时提供该选项，它将被忽略。
`rotation`	number \| undefined	动画结束时的视图旋转。
`anchor`	Coordinate \| undefined	可选锚点，用于在旋转或分辨率动画过程中保持固定。
`duration`	number (defaults to 1000)	动画时长（毫秒）
`easing`	function \| undefined	动画期间使用的缓动函数（默认为`inAndOut`该函数将在每一帧被调用，并接收一个表示动画持续时间比例的数字。该函数应返回一个介于0和1之间的数字，以表示向目标状态的进度。

beginInteraction() View.js, line 1835

通知视图交互已启动。如有需要，视图状态将解析为稳定状态（取决于其约束）。

calculateExtent(size){Extent} View.js, line 999

计算当前视图状态及传入框尺寸的范围。

Name	Type	描述
`size`	Size \| undefined	用于容纳计算范围的盒子的像素尺寸。默认值等于与该视图关联的地图的大小。若视图未关联地图或关联多个地图，则需提供所需的框大小（例如`map.getSize()`).

范围.

cancelAnimations() View.js, line 727

取消所有正在进行的动画。

centerOn(coordinate, size, position) View.js, line 1480

居中于坐标和视图位置。

Name	Type	描述
`coordinate`	Coordinate	坐标。
`size`	Size	框的像素尺寸。
`position`	Pixel	设置视图的中心位置。

changed() inherited Observable.js, line 68

递增修订计数器并触发change事件。

dispatchEvent(event){boolean | undefined} inherited events/Target.js, line 85

分发事件并调用所有监听此类型事件的监听器。事件参数可以是字符串或具有 type 属性的对象。

Name	Type	描述
`event`	BaseEvent \| string	事件对象。

false 如果事件对象上调用了 preventDefault 或任何监听器返回了 false。

endInteraction(duration, resolutionDirection, anchor) View.js, line 1849

通知视图交互已结束。如有需要，视图状态将解析为稳定状态（取决于其约束）。

Name	Type	描述
`duration`	number \| undefined	动画时长（毫秒）
`resolutionDirection`	number \| undefined	缩放方向
`anchor`	Coordinate \| undefined	转变的根源。

fit(geometryOrExtent, options) View.js, line 1344

根据给定的地图尺寸和边界，适配指定的几何图形或范围。尺寸指用于容纳该范围的容器的像素尺寸。在大多数情况下，您应使用地图尺寸，即 map.getSize()。同时考虑地图旋转角度。

Name Type 描述

geometryOrExtent

SimpleGeometry | Extent

适应视图的几何或范围。

options

Options.

Name	Type	描述
`size`	Size \| undefined	用于容纳范围的框的像素大小。默认为与该视图关联的地图的大小。如果视图未关联任何地图或多个地图，请提供所需的框大小（例如`map.getSize()`).
`padding`	Array.<number> (defaults to [0, 0, 0, 0])	视图内边距（以像素为单位）。数组中的值依次为顶部、右侧、底部和左侧的内边距。
`nearest`	boolean (defaults to false)	如果视图`constrainResolution`选项是`true`，获取最近范围，而非实际适配视图的最接近范围。
`minResolution`	number (defaults to 0)	我们缩放至的最小分辨率。
`maxZoom`	number \| undefined	我们缩放至的最大缩放级别。如果`minResolution`若已提供，则该属性会被忽略。
`duration`	number \| undefined	动画时长（毫秒）。默认情况下，目标范围无动画。
`easing`	function \| undefined	动画中使用的缓动函数（默认为`inAndOut`）。该函数将为每个帧调用，传入一个表示动画持续时间比例的数值。该函数应返回一个介于0和1之间的数值，表示向目标状态进展的进度。
`callback`	function \| undefined	视图就位后调用的函数。回调函数将被触发。`true`若动画序列自主完成或`false`如果它已被取消。

get(key){*} inherited Object.js, line 135

获取值。

Name	Type	描述
`key`	string	键名。

值。

getAnimating(){boolean} View.js, line 710

确定视图是否正在动画。

视图正在动画。

getCenter(){Coordinate | undefined} View.js, line 944

获取视图中心。

视图的中心。

getInteracting(){boolean} View.js, line 719

确定用户是否正在与视图交互，例如平移或缩放。

视图正被交互

getKeys(){Array.<string>} inherited Object.js, line 148

获取对象属性名称列表。

属性名称列表。

getMaxResolution(){number} View.js, line 1028

获取视图的最大分辨率。

视图的最大分辨率。

getMaxZoom(){number} View.js, line 1046

获取视图的最大缩放级别。

最大缩放级别。

getMinResolution(){number} View.js, line 1037

获取视图的最小分辨率。

视图的最小分辨率。

getMinZoom(){number} View.js, line 1066

获取视图的最小缩放级别。

最小缩放级别。

getProjection(){Projection} View.js, line 1095

获取视图投影。

视图的投影。

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

获取包含所有属性及其值的对象。

对象。

getResolution(){number | undefined} View.js, line 1105

获取视图分辨率

视图分辨率

getResolutionForExtent(extent, size){number} View.js, line 1127

获取所提供范围的分辨率（以地图单位为单位）和大小（以像素为单位）。

Name	Type	描述
`extent`	Extent	范围.
`size`	Size \| undefined	边界框的像元大小。

在给定尺寸下，所提供范围的渲染分辨率。

getResolutionForZoom(zoom){number} View.js, line 1312

获取缩放级别的分辨率。

Name	Type	描述
`zoom`	number	缩放级别.

在所提供的缩放级别下的视图分辨率。

getResolutions(){Array.<number> | undefined} View.js, line 1115

获取视图的分辨率。该方法返回传递给视图构造函数的分辨率数组；若未指定，则返回 undefined。

视图的分辨率。

getRevision(){number} inherited Observable.js, line 79

获取该对象的版本号。每次修改该对象时，其版本号将自动递增。

修订。

getRotation(){number} View.js, line 1177

获取视图旋转。

视图的旋转（以弧度为单位）。

getZoom(){number | undefined} View.js, line 1272

获取当前缩放级别。若视图未约束分辨率，或交互、动画正在进行，则此方法可能返回非整数缩放级别。

缩放.

getZoomForResolution(resolution){number | undefined} View.js, line 1287

获取分辨率对应的缩放级别。

Name	Type	描述
`resolution`	number	地图分辨率。

对应所提供分辨率的缩放级别。

on(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 152

监听某一类型的事件。

Name	Type	描述
`type`	string \| Array.<string>	事件类型或事件类型数组。
`listener`	function	监听器函数。

监听器的唯一键。如果以事件类型数组作为第一个参数调用，则返回将是键的数组。

once(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 164

一次性监听特定类型的事件。

Name	Type	描述
`type`	string \| Array.<string>	事件类型或事件类型数组。
`listener`	function	监听器函数。

监听器的唯一键。若以事件类型数组作为第一个参数调用，则返回键的数组。

set(key, value, silent) inherited Object.js, line 215

设置值。

Name	Type	描述
`key`	string	键名。
`value`	*	值
`silent`	boolean \| undefined	更新时不触发事件。

setCenter(center) View.js, line 1649

设置当前视图的中心。任何范围约束都将生效。

Name	Type	描述
`center`	Coordinate \| undefined	视图中心。

setConstrainResolution(enabled) View.js, line 1086

设置视图是否允许中间缩放级别。

Name	Type	描述
`enabled`	boolean	分辨率是否受限？

setMaxZoom(zoom) View.js, line 1057

为视图设定新的最大缩放级别。

Name	Type	描述
`zoom`	number	最大缩放级别。

setMinZoom(zoom) View.js, line 1077

为视图设置新的最小缩放级别。

Name	Type	描述
`zoom`	number	最小缩放级别。

setProperties(values, silent) inherited Object.js, line 235

设置键值对集合。注意：此操作将修改现有属性并添加新属性，但不会删除任何现有属性。

Name	Type	描述
`values`	Object.<string, *>	值。
`silent`	boolean \| undefined	更新时不触发事件。

setResolution(resolution) View.js, line 1681

设置该视图的分辨率。任何分辨率限制都将适用。

Name	Type	描述
`resolution`	number \| undefined	视图分辨率。

setRotation(rotation) View.js, line 1692

设置此视图的旋转。任何旋转约束都将生效。

Name	Type	描述
`rotation`	number	视图的旋转（弧度）。

setZoom(zoom) View.js, line 1702

缩放到指定缩放级别。所有分辨率约束均将生效。

Name	Type	描述
`zoom`	number	缩放级别.

un(type, listener) inherited Observable.js, line 173

取消监听某种类型的事件。

Name	Type	描述
`type`	string \| Array.<string>	事件类型或事件类型数组。
`listener`	function	监听器函数。

unset(key, silent) inherited Object.js, line 259

清除属性。

Name	Type	描述
`key`	string	键名。
`silent`	boolean \| undefined	在不触发事件的情况下取消设置。

类：视图

new View(options)

触发事件：

继承

可观察属性

成员

padding{Array.<number>} {undefined}

方法

adjustCenter(deltaCoordinates)

adjustResolution(ratio, anchor)

adjustRotation(delta, anchor)

adjustZoom(delta, anchor)

animate(var_args)

beginInteraction()

calculateExtent(size){Extent}

返回：

cancelAnimations()

centerOn(coordinate, size, position)

changed() inherited

dispatchEvent(event){boolean | undefined} inherited

返回：

endInteraction(duration, resolutionDirection, anchor)

fit(geometryOrExtent, options)

get(key){*} inherited

返回：

getAnimating(){boolean}

返回：

getCenter(){Coordinate | undefined}

返回：

getInteracting(){boolean}

返回：

getKeys(){Array.<string>} inherited

返回：

getMaxResolution(){number}

返回：

getMaxZoom(){number}

返回：

getMinResolution(){number}

返回：

getMinZoom(){number}

返回：

getProjection(){Projection}

返回：

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

返回：

getResolution(){number | undefined}

返回：

getResolutionForExtent(extent, size){number}

返回：

getResolutionForZoom(zoom){number}

返回：

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

返回：

getRevision(){number} inherited

返回：

getRotation(){number}

返回：

getZoom(){number | undefined}

返回：

getZoomForResolution(resolution){number | undefined}

返回：

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

返回：

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

返回：

set(key, value, silent) inherited

setCenter(center)

setConstrainResolution(enabled)

setMaxZoom(zoom)

setMinZoom(zoom)

setProperties(values, silent) inherited

setResolution(resolution)

setRotation(rotation)

setZoom(zoom)

un(type, listener) inherited

unset(key, silent) inherited