类：XYZ

ol/source/XYZ~XYZ瓦片源


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

用于瓦片数据的图层源，其 URL 遵循在 URL 模板中定义的 XYZ 格式。默认情况下，它采用广泛使用的 Google 瓦片网格，其中 x 0 和 y 0 位于左上角。只要图层源没有自定义瓦片网格，就可以通过在 URL 模板中使用 {-y} 占位符来使用像 TMS 这样的网格，其中 x 0 和 y 0 位于左下角。在这种情况下，可以使用 tileUrlFunction，例如：

 tileUrlFunction: function(coordinate) {
   return 'http://mapserver.com/' + coordinate[0] + '/' +
     coordinate[1] + '/' + (-coordinate[2] - 1) + '.png';
 }

new XYZ(options)

source/XYZ.js, line 73
Name Type 描述
attributions AttributionLike | undefined

版权信息。
attributionsCollapsible boolean (defaults to true)

归属是可折叠的。
cacheSize number | undefined

已弃用。请改用图层上的 cacheSize 选项。
crossOrigin null | string | undefined

该crossOrigin表示已加载图像的属性。请注意，您必须提供crossOrigin；若要通过Canvas渲染器访问像素数据，请使用该值。请参阅https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image以获取更多详细信息。
interpolate boolean (defaults to true)

重采样时使用插值。默认情况下，重采样采用线性插值。设置为 false 以使用最近邻。
projection ProjectionLike (defaults to 'EPSG:3857')

投影.
reprojectionErrorThreshold number (defaults to 0.5)

最大允许重投影误差（像素）。较高的设置值可提升重投影效率，但会降低精度。
maxZoom number (defaults to 42)

可选的最大缩放级别。若不使用，tileGrid已提供。
minZoom number (defaults to 0)

可选的最小缩放级别。如果不使用，tileGrid已提供。
maxResolution number | undefined

零级可选瓦片网格分辨率。如果不使用。tileGrid已提供。
tileGrid TileGrid | undefined

瓦片 网格.
tileLoadFunction LoadFunction | undefined

已弃用。请改用带加载器的 ImageTile 源。用于加载指定 URL 的瓦片的可选函数。默认为

function(imageTile, src) {
  imageTile.getImage().src = src;
};
tilePixelRatio number (defaults to 1)

瓦片服务所使用的像素比。例如，若瓦片服务宣称其瓦片尺寸为 256×256 像素，但实际发送 512×512 像素的图像（针对视网膜或高DPI设备），则tilePixelRatio应设置为2.
tileSize number | Size (defaults to [256, 256])

切片服务所使用的切片大小。如果不使用切片服务，则此参数无效。tileGrid已提供。
gutter number (defaults to 0)

要忽略的图像图块周边边距的像素大小。这样可以消除瓦片边缘的渲染伪影。支持的图像宽度和高度应大于瓦片尺寸，且超出部分需指定一个值。2 x gutter.
tileUrlFunction UrlFunction | undefined

已弃用。请使用ImageTile源，并为url选项提供一个函数。
url string | undefined

URL模板必须包含{x}, {y}或者{-y}，和{z}占位符。A{?-?}模板模式，例如subdomain{a-f}.domain.com，可用于替代在分别定义每个urls选项。
urls Array.<string> | undefined

已弃用。请改用ImageTile源，并为url选项提供URL数组。
wrapX boolean (defaults to true)

是否水平包裹世界。
transition number (defaults to 250)

渲染时的不透明度过渡持续时间。要禁用不透明度过渡，请传递transition: 0.
zDirection number | NearestDirectionFunction (defaults to 0)

在整数缩放级别之间，选择是否使用更高或更低缩放级别的图块。参见getZForResolution.
触发事件：

子类

继承

方法

changed() inherited

Observable.js, line 68

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

clear() inherited

source/Tile.js, line 258

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

dispatchEvent(event){boolean | undefined} inherited

events/Target.js, line 85

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

Name Type 描述
event BaseEvent | string

事件对象。
返回：
false 如果事件对象上调用了 preventDefault 或者任何监听器返回了 false。

get(key){*} inherited

Object.js, line 135

获取一个值。

Name Type 描述
key string

键名。
返回：
值。

getAttributions(){Attribution} inherited

source/Source.js, line 129

获取数据源的归属函数。

返回：
版权功能。

getAttributionsCollapsible(){boolean} inherited

source/Source.js, line 137
返回：
版权信息是可折叠的。

getKeys(){Array.<string>} inherited

Object.js, line 148

获取对象属性名称列表。

返回：
属性名称列表。

getProjection(){Projection | null} inherited

source/Source.js, line 146

获取数据源的投影。

返回：
投影.

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

Object.js, line 157

获取包含所有属性名称和值的对象。

返回：
对象。

getRevision(){number} inherited

Observable.js, line 79

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

返回：
修订。

getState(){State} inherited

source/Source.js, line 170

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

返回：
状态。

getTileGrid(){TileGrid | null} inherited

source/Tile.js, line 190

返回瓦片源的瓦片网格。

返回：
瓦片 网格.

getTileLoadFunction(){LoadFunction} inherited

source/UrlTile.js, line 100

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

返回：
瓦片加载函数

getTileUrlFunction(){UrlFunction} inherited

source/UrlTile.js, line 110

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

返回：
瓦片URL函数

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

source/UrlTile.js, line 124

已弃用。建议使用图像瓦片源。 返回此源使用的URL。 若使用tileUrlFunction而非url或urls，则返回null。

返回：
网址。

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

Observable.js, line 152

监听特定类型的事件。

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

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

监听器函数。
返回：
监听器的唯一键。当使用事件类型数组作为首个参数进行调用时，返回值为键的数组。

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

Observable.js, line 164

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

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

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

监听器函数
返回：
监听器的唯一键。当以事件类型数组作为第一个参数调用时，返回值将是一个键数组。

set(key, value, silent) inherited

Object.js, line 215

设置值。

Name Type 描述
key string

键名。
value *

值。
silent boolean | undefined

更新时不触发事件。

setAttributions(attributions) inherited

source/Source.js, line 203

设置源的归属信息。

Name Type 描述
attributions AttributionLike | undefined

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

setProperties(values, silent) inherited

Object.js, line 235

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

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

值。
silent boolean | undefined

更新而不触发事件。

setRenderReprojectionEdges(render) inherited

source/TileImage.js, line 291

控制是否渲染重投影边界（通常用于调试）。

Name Type 描述
render boolean

渲染边界。

setTileGridForProjection(projection, tilegrid) inherited

source/TileImage.js, line 311

设置用于将瓦片重投影至给定投影的瓦片网格，替代该投影的默认瓦片网格。

在无法创建默认瓦片网格（例如投影未定义范围）或为优化性能（如自定义瓦片大小、分辨率等）时，此方法可能很有用。

Name Type 描述
projection ProjectionLike

投影.
tilegrid TileGrid

投影的瓦片网格。

setTileLoadFunction(tileLoadFunction) inherited

source/UrlTile.js, line 161

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

Name Type 描述
tileLoadFunction LoadFunction

瓦片加载函数。

setTileUrlFunction(tileUrlFunction, key) inherited

source/UrlTile.js, line 173

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

Name Type 描述
tileUrlFunction UrlFunction

瓦片URL函数
key string | undefined

源的可选新瓦片键。

setUrl(url) inherited

source/UrlTile.js, line 187

设置请求的URL。

Name Type 描述
url string

网址。

setUrls(urls) inherited

source/UrlTile.js, line 199

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

Name Type 描述
urls Array.<string>

网址。

un(type, listener) inherited

Observable.js, line 173

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

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

事件类型或其数组。
listener function

监听函数。

unset(key, silent) inherited

Object.js, line 259

清除属性。

Name Type 描述
key string

键名。
silent boolean | undefined

清除设置而不触发事件。