类:OSM

ol/source/OSM~开放街图


import OSM from 'ol/source/OSM.js';

OpenStreetMap切片服务器的图层源。

new OSM(options)

Name Type 描述
attributions AttributionLike | undefined

版权信息。

cacheSize number | undefined

已弃用。请使用图层的 cacheSize 选项替代。

crossOrigin null | string (defaults to 'anonymous')

crossOrigin 用于图像加载的属性。请注意,必须提供一个值。crossOrigin:若要通过 Canvas 渲染器访问像素数据,请使用此值。有关更多详情,请参见https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image

interpolate boolean (defaults to true)

重采样时默认使用线性插值;如需使用最近邻插值,请将设置设为假。

maxZoom number (defaults to 19)

最大缩放。

reprojectionErrorThreshold number (defaults to 0.5)

允许的最大重投影误差(像素单位)。较高的值可提升重投影性能,但会降低精度。

tileLoadFunction LoadFunction | undefined

用于加载给定 URL 的瓦片的可选函数。默认为

function(imageTile, src) {
  imageTile.getImage().src = src;
};
transition number (defaults to 250)

渲染时的不透明度过渡持续时间。要禁用不透明度过渡,请传递一个transition: 0.

url string (defaults to 'https://tile.openstreetmap.org/{z}/{x}/{y}.png')

URL模板必须包含{x}, {y}{-y},和{z}占位符。

wrapX boolean (defaults to true)

是否水平包裹世界?

zDirection number | NearestDirectionFunction (defaults to 0)

当缩放级别介于整数之间时,选择是否使用更高或更低缩放级别的图块。参见getZForResolution.

触发事件:

继承

方法

递增修订计数器并分发“更改”事件。

从源中移除所有缓存的重新投影瓦片。下一个渲染周期将创建新的瓦片。

dispatchEvent(event){boolean | undefined} inherited

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

Name Type 描述
event BaseEvent | string

事件对象。

返回:
false 如果对事件对象调用了preventDefault方法,或者任何事件监听器返回了false。

获取一个值。

Name Type 描述
key string

键名。

返回:
值。

获取数据源的归属函数。

返回:
归属功能。

getAttributionsCollapsible(){boolean} inherited

返回:
归属信息是可折叠的。

getKeys(){Array.<string>} inherited

获取对象属性名称列表。

返回:
属性名称列表

getProjection(){Projection | null} inherited

获取数据源的投影。

返回:
投影.

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

获取所有属性名称及其值的对象。

返回:
对象。

getRevision(){number} inherited

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

返回:
修订。

获取数据源的状态,请参阅 State 了解可能的状态。

返回:
状态。

getTileGrid(){TileGrid | null} inherited

返回瓦片源的瓦片网格。

返回:
瓦片 网格.

已弃用。请改用图像瓦片源。 返回源的瓦片加载函数。

返回:
瓦片加载函数

已弃用。请改用 ImageTile 源。返回该源的瓦片URL函数。

返回:
瓦片URL函数

getUrls(){!Array.<string> | null} inherited

已弃用。请改用图像瓦片源。返回此源所使用的URL。当使用tileUrlFunction而非url或urls时,将返回null。

返回:
网址。

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

监听特定类型的事件。

Name Type 描述
type string | Array.<string>

事件类型或事件类型数组。

listener function

监听器函数

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

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

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

Name Type 描述
type string | Array.<string>

事件类型或事件类型数组。

listener function

监听器函数。

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

set(key, value, silent) inherited

设置值。

Name Type 描述
key string

键名。

value *

值。

silent boolean | undefined

在不触发事件的情况下更新。

setAttributions(attributions) inherited

设置源的归属。

Name Type 描述
attributions AttributionLike | undefined

版权声明。可作为string, Array<string>, Attribution,或undefined.

setProperties(values, silent) inherited

设置一组键值对。请注意,此操作将修改现有属性并添加新属性,但不会删除任何现有属性。

Name Type 描述
values Object.<string, *>

值。

silent boolean | undefined

更新而不触发事件

setRenderReprojectionEdges(render) inherited

控制是否渲染重投影边缘(通常用于调试)。

Name Type 描述
render boolean

渲染边线。

setTileGridForProjection(projection, tilegrid) inherited

设置用于将瓦片重新投影到给定投影的瓦片网格,而非该投影的默认瓦片网格。

当默认图块网格无法创建时(例如投影未定义范围),或为优化性能(如自定义图块大小、分辨率等),此设置可能很有用。

Name Type 描述
projection ProjectionLike

投影.

tilegrid TileGrid

用于投影的瓦片网格。

setTileLoadFunction(tileLoadFunction) inherited

已弃用。请改用ImageTile源。 设置源的瓦片加载函数。

Name Type 描述
tileLoadFunction LoadFunction

瓦片加载函数。

setTileUrlFunction(tileUrlFunction, key) inherited

已弃用。请改用图像瓦片源。设置源的瓦片URL函数。

Name Type 描述
tileUrlFunction UrlFunction

瓦片 URL 函数

key string | undefined

源的可选新瓦片键。

设置请求URL。

Name Type 描述
url string

网址。

已弃用。请改用 ImageTile 源。设置请求的URL。

Name Type 描述
urls Array.<string>

网址。

un(type, listener) inherited

取消监听特定类型的事件。

Name Type 描述
type string | Array.<string>

事件类型或事件类型的数组。

listener function

监听器函数。

unset(key, silent) inherited

清除属性。

Name Type 描述
key string

键名。

silent boolean | undefined

取消设置而不触发事件。