Module: ol/Map

ol/Map


Classes

Map

Type Definitions

AtPixelOptions{Object}

Properties:
Name Type Description
layerFilter undefined | function

图层过滤函数。过滤函数将接收一个参数，即 layer-candidate，并应返回布尔值。只有可见且此函数返回 true 的图层才会被测试要素。默认情况下，所有可见图层都将被测试。
hitTolerance number
(defaults to 0)

命中检测容差（CSS 像素）。给定位置半径内的像素将被检查是否包含要素。
checkWrapped boolean
(defaults to true)

检查环绕 将在 +/- 1 个世界宽度范围内检查环绕的几何对象。 仅在使用可环绕的投影时有效。

FrameState{Object}

当前帧的状态。应用中仅应使用 pixelRatio、time 和 viewState。

Properties:
Name Type Description
pixelRatio number

帧的像素比。
time number

请求渲染帧的时间。
viewState State

当前视图的状态。
animate boolean

动画。
coordinateToPixelTransform Transform

坐标到像素的变换。
declutter Object<string, module:rbush<DeclutterEntry>> | null

按去重组分组的去重树。当为 null 时，不需要去重，因为没有图层启用了去重。
extent null | Extent

范围（视图投影坐标）。
nextExtent Extent | undefined

动画系列期间的下一个范围。
index number

索引。
layerStatesArray Array<State>

图层状态数组。
layerIndex number

Layer索引。
pixelToCoordinateTransform Transform

像素到坐标的变换。
postRender函数s Array<PostRender函数>

后渲染函数。
size Size

大小。
tileQueue TileQueue

瓦片队列。
usedTiles 对象。<string, 对象。<string, boolean>>

已用瓦片。
viewHints Array.<number>

视图提示。
wantedTiles 对象。<string, 对象。<string, boolean>>

所需瓦片。
mapId string

地图的 ID。
renderTargets 对象。<string, boolean>

先前渲染元素的标识符。

MapObjectEventTypes{Types} {'change:layergroup'} {'change:size'} {'change:target'} {'change:view'}

MapOptions{Object}

包含地图配置选项的对象字面量。

Properties:
Name Type Description
controls Collection<Control> | Array<Control> | undefined

初始添加到地图的控件。如果未指定，则使用 defaults。在工作线程中，默认不添加控件。
pixelRatio number
(defaults to window.devicePixelRatio)

设备上物理像素与设备无关像素（dips）之间的比率。
interactions Collection<Interaction> | Array<Interaction> | undefined

初始添加到地图的交互。如果未指定，则使用 defaults。在工作线程中，默认不添加交互。
keyboardEventTarget HTMLElement | Document | string | undefined

监听键盘事件的元素。这决定了 KeyboardPan 和 KeyboardZoom 交互何时触发。例如，如果此选项设置为 document，键盘交互将始终触发。如果未指定此选项，库监听键盘事件的元素是地图目标（即用户提供的地图 div）。如果不是 document，目标元素需要获得焦点才能发出键事件，这要求目标元素具有 tabindex 属性。
layers Array<BaseLayer> | Collection<BaseLayer> | LayerGroup | undefined

图层。如果未定义，将渲染一个没有图层的地图。注意图层按提供的顺序渲染，因此如果您希望矢量图层显示在瓦片图层之上，它必须位于瓦片图层之后。
maxTilesLoading number
(defaults to 16)

同时加载的最大瓦片数。
moveTolerance number
(defaults to 1)

光标必须移动的最小像素距离才能被检测为地图移动事件而非点击。增加此值可以使点击地图更容易。
overlays Collection<Overlay> | Array<Overlay> | undefined

初始添加到地图的覆盖物。默认不添加覆盖物。
target HTMLElement | string | HTMLCanvasElement | OffscreenCanvas | undefined

地图容器，可以是元素本身或元素的 id。如果构造时未指定，必须调用 setTarget 才能渲染地图。如果通过元素传递，容器可以在辅助文档中。在工作线程中使用或导出地图时，使用 OffscreenCanvas 或 HTMLCanvasElement 作为目标，具有以物理像素为单位的宽度和高度，可选择乘以与地图像素比匹配的缩放变换。对于无障碍访问（地图导航的焦点和键盘事件），target 元素必须具有正确配置的 tabindex 属性。如果 target 元素在 Shadow DOM 内，tabindex 属性必须设置在自定义元素的宿主元素上。注意：CSS transform 对目标元素的支持仅限于 scale。
view View | Promise<ViewOptions> | undefined

地图的视图。除非在构造时或通过 setView 指定，否则不会获取图层数据源。

MapOptionsInternal{Object}

Properties:
Name Type Description
controls Collection<Control> | undefined

控件。
interactions Collection<Interaction> | undefined

交互。
keyboardEventTarget HTMLElement | Document

KeyboardEvent目标。
overlays Collection<Overlay>

覆盖物。
values 对象。<string, *>

值。

PostRender函数()

Map.js, line 79