模块:ol/View

ol/View


View

类型定义

Animation{Object}

动画配置

属性:
Name Type 描述
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}

属性:
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之间的数值,表示向目标状态进展的进度。

Constraints{Object}

属性:
Name Type 描述
center Type

中心

resolution Type

分辨率.

rotation Type

旋转.

FitOptions{Object}

属性:
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如果它已被取消。

State{Object}

属性:
Name Type 描述
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}

属性:
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如果...,选项无效enableRotationfalse.

extent Extent | undefined

约束视图的范围,换句话说,此范围之外的内容在地图上均不可见。

constrainOnlyCenter boolean
(defaults to false)

当设置为true时,范围约束仅适用于视图中心,而不适用于整个范围。

smoothExtentConstraint boolean
(defaults to 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)

若设置为 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 像素)。当地图视口的边缘被其他内容(覆盖物)部分遮挡时,此设置可使视口中心远离该内容。值的顺序为:上、右、下、左。

ViewStateLayerStateExtent{Object}

类似于 FrameState,但仅限于 viewStateextent

属性:
Name Type 描述
viewState State

视图状态。

extent Extent

范围(在用户投影坐标系下)。

layerStatesArray Array<State> | undefined

图层状态。