类:StadiaMaps

ol/source/StadiaMaps~斯泰迪亚地图


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

用于 Stadia Maps 瓦片服务器的图层源。

new StadiaMaps(options)

Name Type 描述
cacheSize number | undefined

已弃用。建议改用图层上的 cacheSize 选项。

interpolate boolean (defaults to true)

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

layer string

图层名称:有效值:alidade_smooth, alidade_smooth_dark, outdoors, stamen_terrain, stamen_terrain_background, stamen_terrain_labels, stamen_terrain_lines, stamen_toner_background, stamen_toner, stamen_toner_labels, stamen_toner_lines, stamen_toner_lite, stamen_watercolor,和osm_bright.

minZoom number | undefined

最小缩放级别。

maxZoom number | undefined

最大缩放。

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 | undefined

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

wrapX boolean (defaults to true)

是否水平环绕世界?

zDirection number | NearestDirectionFunction (defaults to 0)

选择在整数缩放级别之间使用较高或较低缩放级别的瓦片。请参阅getZForResolution.

apiKey string | undefined

Stadia Maps API 密钥。在本地主机或大多数公共Web部署中,无需此密钥。详细信息请参见https://docs.stadiamaps.com/authentication/

retina boolean | undefined

使用视网膜图块(如果可用;不适用于Stamen水彩)。

触发事件:

继承

方法

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

从源中移除所有已缓存的重投影切片。下一个渲染周期将生成新的切片。

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源。返回源的瓦片加载函数。

返回:
瓦片加载函数

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

返回:
瓦片URL函数

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

已弃用。请改用 ImageTile 源。 返回此源所使用的 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

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

Name Type 描述
tileUrlFunction UrlFunction

瓦片URL函数。

key string | undefined

源的可选新图块键。

设置请求的URL。

Name Type 描述
url string

网址。

已弃用。请改用图像瓦片源。设置请求所使用的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

取消设置且不触发事件。