Module: ol/View

ol/View


Classes

View

函数s

getView(source, transforms){Promise<ViewOptions>}

import {getView} from 'ol/View';

对从数据源解析的视图应用一系列变换。

Name Type Description
source Source

数据源。

transforms ViewTransform

要应用的变换。

返回值:
The view options.

withExtentCenter(){ViewTransform}

import {withExtentCenter} from 'ol/View';

基于范围应用中心点。

返回值:
A view transform.

withLowerResolutions(num){ViewTransform}

import {withLowerResolutions} from 'ol/View';

添加lower resolutions.

Name Type Description
num number

要使用的较低分辨率级别数。

返回值:
A view transform.
import {withZoom} from 'ol/View';

应用缩放级别。

Name Type Description
z number

缩放级别。

返回值:
A view transform.

Type Definitions

Animation{Object}

动画配置

Properties:
Name Type Description
sourceCenter Coordinate | undefined

数据源中心。

targetCenter Coordinate | undefined

目标中心。

sourceResolution number | undefined

源分辨率。

targetResolution number | undefined

目标分辨率。

sourceRotation number | undefined

数据源旋转。

targetRotation number | undefined

目标旋转。

anchor Coordinate | undefined

锚点。

start number

起始。

duration number

持续时间。

complete boolean

完成。

easing function

缓动。

callback function

回调。

AnimationOptions{Object}

Properties:
Name Type Description
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 之间的数字,表示向目标状态的进度。

Constraints{Object}

Properties:
Name Type Description
center Type

中心。

resolution Type

分辨率。

rotation Type

旋转角度。

FitOptions{Object}

Properties:
Name Type Description
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(如果被取消)。

State{Object}

Properties:
Name Type Description
center Coordinate

中心点(视图投影坐标)。

projection Projection

投影。

resolution number

分辨率。

nextCenter Coordinate | undefined

动画系列期间的下一个中心。

nextResolution number | undefined

动画系列期间的下一个分辨率。

nextRotation number | undefined

动画系列期间的下一个旋转。

rotation number

旋转角度。

zoom number

缩放。

ViewObjectEventTypes{Types} {'change:center'} {'change:resolution'} {'change:rotation'}

ViewOptions{Object}

Properties:
Name Type Description
center Coordinate | undefined

视图的初始中心。如果未设置用户投影,中心的坐标系由 projection 选项指定。如果未设置此项,图层数据源将不会被获取,但可以稍后通过 #setCenter 设置中心。

constrainRotation boolean | number
(defaults to true)

旋转约束。false 表示无约束。true 表示无约束,但在接近零时对齐到零。数字将旋转约束为该数量的值。例如,4 将旋转约束为 0、90、180 和 270 度。

enableRotation boolean
(defaults to true)

启用旋转。如果为 false,将使用始终将旋转设置为零的旋转约束。如果 enableRotationfalseconstrainRotation 选项无效。

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,则优先使用 minResolution

minZoom number
(defaults to 0)

用于确定分辨率约束的最小缩放级别。与 maxZoom(或 minResolution)和 zoomFactor 一起使用。注意如果同时提供了 maxResolution,则优先使用 maxResolution

multiWorld boolean
(defaults to false)

如果为 false,视图将被约束为只显示一个世界,并且不能平移出边缘。如果为 true,地图在低缩放级别可能显示多个世界。仅在 projection 为全局投影时使用。注意如果同时提供了 extent,则优先使用 extent

constrainResolution boolean
(defaults to false)

如果为 true,视图将始终在交互后动画到最近的缩放级别;false 表示允许中间缩放级别。

smoothResolutionConstraint boolean
(defaults to true)

如果为 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

决定缩放级别的分辨率(如果指定)。数组中的索引对应于缩放级别,因此分辨率值必须按降序排列。它还通过最小值和最大值约束分辨率。如果设置,maxResolutionminResolutionminZoommaxZoomzoomFactor 选项将被忽略。

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 像素)。如果地图视口沿边缘部分被其他内容(覆盖物)覆盖,此设置允许将视口中心从该内容偏移。值的顺序为上、右、下、左。

ViewStateLayerStateExtent{Object}

类似于 FrameState,但只有 viewStateextent

Properties:
Name Type Description
viewState State

视图状态。

extent Extent

范围(用户投影坐标)。

layerStatesArray Array<State> | undefined

图层状态。

ViewTransform()