Class: XYZ

ol/source/XYZ~XYZ 


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

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

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

new XYZ(options)

source/XYZ.js, line 74
Name Type Description
attributions AttributionLike | undefined

归属信息。
attributionsCollapsible boolean (defaults to true)

归属信息是否可折叠。
cacheSize number | undefined

已弃用。 请改用图层上的 cacheSize 选项。
crossOrigin null | string | undefined 已加载图像的 crossOrigin 属性。注意如果要使用 Canvas 渲染器访问像素数据，必须提供 crossOrigin 值。详见 https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image。
referrerPolicy ReferrerPolicy | undefined

已加载图像的 referrerPolicy 属性。
interpolate boolean (defaults to true)

重采样时是否使用插值。默认情况下， 重采样时使用线性插值。设置为 false 可使用 the nearest neighbor instead.
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

瓦片网格。
tileLoad函数 Load函数 | undefined

已弃用。请改用带 loader 的 ImageTile 数据源。给定 URL 加载瓦片的可选函数。默认为

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

瓦片服务使用的像素比。例如，如果瓦片服务宣传 256x256 像素瓦片但实际发送 512x512 像素图像（用于 retina/hidpi 设备），则 tilePixelRatio 应设置为 2。
tileSize number | Size (defaults to [256, 256])

瓦片服务使用的瓦片尺寸。如果提供了 tileGrid 则不使用。
gutter number (defaults to 0)

图像瓦片周围要忽略的边距大小（像素）。这允许忽略瓦片边缘的渲染伪影。支持的图像应比瓦片尺寸宽和高 2 x gutter 值。
tileUrl函数 Url函数 | undefined

已弃用。 请改用 ImageTile 数据源并通过 url 选项提供函数。
url string | undefined

URL 模板。必须包含 {x}、{y} 或 {-y}，以及 {z} 占位符。可以使用 {?-?} 模板模式（例如 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 | NearestDirection函数 (defaults to 0)

选择在整数缩放级别之间使用更高还是更低缩放级别的瓦片。参见 getZForResolution。
触发事件：

Subclasses

Extends

Methods

changed() inherited

Observable.js, line 68

增加修订计数器并分发 'change' 事件。

clear() inherited

source/Tile.js, line 258

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

dispatchEvent(event){boolean | undefined} inherited

events/Target.js, line 85

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

Name Type Description
event BaseEvent | string

事件对象。
返回值：
如果有人在事件对象上调用了 preventDefault 或任何监听器返回 false，则返回 false。

get(key){*} inherited

Object.js, line 136

获取一个值。

Name Type Description
key string

键名。
返回值：
值。

getAttributions(){Attribution} inherited

source/Source.js, line 129

获取数据源的归属函数。

返回值：
Attribution function.

getAttributionsCollapsible(){boolean} inherited

source/Source.js, line 137
返回值：
归属信息是否可折叠。

getKeys(){Array.<string>} inherited

Object.js, line 149

获取对象属性名列表。

返回值：
属性名列表。

getProjection(){Projection | null} inherited

source/Source.js, line 146

获取数据源的投影。

返回值：
投影。

getProperties(){NoInfer.<Properties>} inherited

Object.js, line 158

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

返回值：
对象。

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

返回瓦片数据源的瓦片网格。

返回值：
瓦片网格。

getTileLoad函数(){Load函数} inherited

source/UrlTile.js, line 100

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

返回值：
TileLoad函数

getTileUrl函数(){Url函数} inherited

source/UrlTile.js, line 110

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

返回值：
TileUrl函数

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

source/UrlTile.js, line 124

已弃用。 请改用 ImageTile 数据源。 返回此数据源使用的 URL。 当使用 tileUrl函数 时ad of url or urls, null will be returned.

返回值：
URL 列表。

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

Observable.js, line 152

监听特定类型的事件。

Name Type Description
type string | Array.<string>

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

监听器函数。
返回值：
监听器的唯一键。如果第一个参数是事件类型数组，则返回键的数组。

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

Observable.js, line 164

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

Name Type Description
type string | Array.<string>

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

监听器函数。
返回值：
监听器的唯一键。如果第一个参数是事件类型数组，则返回键的数组。

set(key, value, silent) inherited

Object.js, line 218

设置一个值。

Name Type Description
key string

键名。
value *

值。
silent boolean | undefined

更新但不触发事件。

setAttributions(attributions) inherited

source/Source.js, line 203

设置数据源的归属信息。

Name Type Description
attributions AttributionLike | undefined

归属信息。可以作为字符串、Array<string>、Attribution 或 undefined 传入。

setProperties(values, silent) inherited

Object.js, line 238

设置一组键值对。 注意，这会更改任何现有属性并添加新属性（不会移除任何现有属性）。

Name Type Description
values Partial.<NoInfer.<Properties>>

值。
silent boolean | undefined

更新但不触发事件。

setRenderReprojectionEdges(render) inherited

source/TileImage.js, line 301

设置是否渲染重投影边缘（通常用于调试）。

Name Type Description
render boolean

渲染边缘。

setTileGridForProjection(projection, tilegrid) inherited

source/TileImage.js, line 321

设置在将瓦片重投影到给定投影时使用的瓦片网格， 而不是默认的瓦片网格rojection.

当无法创建默认瓦片网格（例如投影未定义范围）或出于优化原因（自定义瓦片尺寸、分辨率等）时，这可能很有用。

Name Type Description
projection ProjectionLike

投影。
tilegrid TileGrid

用于投影的瓦片网格。

setTileLoad函数(tileLoad函数) inherited

source/UrlTile.js, line 161

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

Name Type Description
tileLoad函数 Load函数

瓦片加载函数。

setTileUrl函数(tileUrl函数, key) inherited

source/UrlTile.js, line 173

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

Name Type Description
tileUrl函数 Url函数

瓦片 URL 函数。
key string | undefined

数据源的可选新瓦片键。

setUrl(url) inherited

source/UrlTile.js, line 187

设置用于请求的 URL。

Name Type Description
url string

URL.

setUrls(urls) inherited

source/UrlTile.js, line 199

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

Name Type Description
urls Array.<string>

URL 列表。

un(type, listener) inherited

Observable.js, line 173

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

Name Type Description
type string | Array.<string>

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

监听器函数。

unset(key, silent) inherited

Object.js, line 262

取消设置一个属性。

Name Type Description
key string

键名。
silent boolean | undefined

取消设置但不触发事件。