Cesium API - UrlTemplateImageryProvider 中文文档

new Cesium.UrlTemplateImageryProvider(options)

通过使用指定的URL模板请求瓦片来提供图像。

Name Type Description

options

Promise.<Object> | Object

optional 此对象拥有以下属性：

Name	Type	Default	Description
`url`	Resource \| String		用于请求瓦片的URL模板。它具有以下关键字： `{z}`: 级别 `{x}`: 瓦片X坐标 `{y}`: 瓦片Y坐标 `{s}`: 可用的子域之一，用于克服浏览器对每个主机的并发请求数的限制 `{reverseX}`: 切片方案中的切片X坐标，其中0是最东端的切片 `{reverseY}`: 切片方案中的切片Y坐标，其中0是最南端的切片 `{reverseZ}`: 切片方案中切片的级别，其中级别0是四叉树金字塔的最大级别。为了使用reverseZ，必须定义maximumLevel `{westDegrees}`: 最小经度 `{southDegrees}`: 最小纬度 `{eastDegrees}`:最大经度 `{northDegrees}`: 最大纬度 `{westProjected}`: 在切片方案的投影坐标系下的最小X坐标 `{southProjected}`: 在切片方案的投影坐标系下的最小Y坐标 `{eastProjected}`: 在切片方案的投影坐标系下的最大X坐标 `{northProjected}`: 在切片方案的投影坐标系下的最大Y坐标 `{width}`: 瓦片宽 `{height}`: 瓦片高
`pickFeaturesUrl`	Resource \| String		optional 用于选择要素的URL模板。如果未指定此属性，则`UrlTemplateImageryProvider#pickFeatures`将立即返回undefined，表示未选择任何要素。 URL模板支持url 参数支持的所有关键字，以及以下内容： {i}: 拾取位置的像素列（水平坐标），其中最西端的像素为0 {j}: 拾取位置的像素行（垂直坐标），其中最北端的像素为0 {reverseI}: 拾取位置的像素列（水平坐标），其中最东端的像素为0 {reverseJ}: 拾取位置的像素行（垂直坐标），其中最南端的像素为0 {longitudeDegrees}: 所选位置的经度（以度为单位） {latitudeDegrees}: 所选位置的纬度（以度为单位） {longitudeProjected}: 切片方案投影坐标中拾取位置的经度 {latitudeProjected}: 切片方案投影坐标中拾取位置的纬度 {format}: GetFeatureInfoFormat中指定的获取要素信息的格式
`urlSchemeZeroPadding`	Object		optional 获取每个瓦片坐标的URL方案零填充。格式为'000'，其中每个坐标将在左侧填充0，以匹配传递的0字符串的宽度。例如，设置： urlSchemeZeroPadding : { '{x}' : '0000'}，将导致一个'x'值12返回字符串'0012'为{x}在生成的URL。它传递的对象有以下关键字： `{z}`: 在切片方案中瓦片级别的零填充 `{x}`: 在切片方案中瓦片X坐标的零填充 `{y}`: 在切片方案中瓦片Y坐标的零填充 `{reverseX}`: 在切片方案中，瓦片的反转X坐标的零填充 `{reverseY}`: 在切片方案中，瓦片的反转Y坐标的零填充 `{reverseZ}`: 在切片方案中，瓦片的反转Z坐标的零填充
`subdomains`	String \| Array.<String>	`'abc'`	optional URL模板中用于`{s} 占位符的子域。如果此参数是单个字符串，则字符串中的每个字符都是一个子域。如果是数组，则数组中的每个元素都是一个子域。`
`credit`	Credit \| String	`''`	optional 版权信息。
`minimumLevel`	Number	`0`	optional 图像提供器支持的最小级别。指定此值时，请注意最小级别的切片数量较小，例如四个或更少。数量较大可能会导致渲染问题。
`maximumLevel`	Number		optional 图像提供器支持的最大级别，如果没有限制，则为未定义。
`rectangle`	Rectangle	`Rectangle.MAX_VALUE`	optional 地图矩形范围，以弧度为单位。
`tilingScheme`	TilingScheme	`WebMercatorTilingScheme`	optional 切片方案指定如何将椭球表面分解为瓦片。如果未提供此参数，则使用`WebMercatorTilingScheme`。
`ellipsoid`	Ellipsoid		optional 椭球。如果指定了tilingScheme，则将忽略此参数，而是使用切片方案的椭圆体。如果未指定任何参数，则使用WGS84椭球。
`tileWidth`	Number	`256`	optional 瓦片宽。
`tileHeight`	Number	`256`	optional 瓦片高。
`hasAlphaChannel`	Boolean	`true`	optional 是否含有Alpha通道。
`getFeatureInfoFormats`	Array.<GetFeatureInfoFormat>		optional 调用`UrlTemplateImageryProvider#pickFeatures`时在特定位置获取要素信息的格式。如果未指定此参数，则禁用要素选择。
`enablePickFeatures`	Boolean	`true`	optional 是否启用拾取要素。
`customTags`	Object		optional 允许替换URL模板中的自定义关键字。该对象必须具有字符串作为键，并且必须具有值。

示例：

// 获取使用TMS切片方案和地理（EPSG：4326）项目的Natural Earth II影像
var tms = new Cesium.UrlTemplateImageryProvider({
    url : Cesium.buildModuleUrl('Assets/Textures/NaturalEarthII') + '/{z}/{x}/{reverseY}.jpg',
    credit : '© Analytical Graphics, Inc.',
    tilingScheme : new Cesium.GeographicTilingScheme(),
    maximumLevel : 5
});
// 访问CartoDB Positron底图，该底图使用类似OpenStreetMap的切片方案。
var positron = new Cesium.UrlTemplateImageryProvider({
    url : 'http://{s}.basemaps.cartocdn.com/light_all/{z}/{x}/{y}.png',
    credit : 'Map tiles by CartoDB, under CC BY 3.0. Data by OpenStreetMap, under ODbL.'
});
// 访问Web地图服务（WMS）服务器。
var wms = new Cesium.UrlTemplateImageryProvider({
   url : 'https://programs.communications.gov.au/geoserver/ows?tiled=true&' +
         'transparent=true&format=image%2Fpng&exceptions=application%2Fvnd.ogc.se_xml&' +
         'styles=&service=WMS&version=1.1.1&request=GetMap&' +
         'layers=public%3AMyBroadband_Availability&srs=EPSG%3A3857&' +
         'bbox={westProjected}%2C{southProjected}%2C{eastProjected}%2C{northProjected}&' +
         'width=256&height=256',
   rectangle : Cesium.Rectangle.fromDegrees(96.799393, -43.598214999057824, 153.63925700000001, -9.2159219997013)
});
// 在模板网址中使用自定义标记。
var custom = new Cesium.UrlTemplateImageryProvider({
   url : 'https://yoururl/{Time}/{z}/{y}/{x}.png',
   customTags : {
       Time: function(imageryProvider, x, y, level) {
           return '20171231'
       }
   }
});

参考：

成员变量

readonlycredit : Credit

Scene/UrlTemplateImageryProvider.js 473

获取版权信息。UrlTemplateImageryProvider#ready返回true之前，不应调用此函数。

Default Value: undefined

enablePickFeatures : Boolean

Scene/UrlTemplateImageryProvider.js 205

获取或设置一个值，该值指示是否启用要素拾取。如果为true，UrlTemplateImageryProvider#pickFeatures将请求options.pickFeaturesUrl，并尝试解释响应中包含的要素。如果为false， UrlTemplateImageryProvider#pickFeatures将立即返回undefined（指示没有可拾取的要素），而不与服务器通信。如果您知道您的数据源不支持拾取要素，或者您不希望提供者的要素可拾取，则将此属性设置为false。

Default Value: true

readonlyerrorEvent : Event

Scene/UrlTemplateImageryProvider.js 436

获取此提供器遇到异步错误时触发的事件。通过订阅事件，您将收到错误通知，并可能从中恢复。事件监听器传递一个TileProviderError的实例。

readonlyhasAlphaChannel : Boolean

Scene/UrlTemplateImageryProvider.js 491

获取影像是否有Alpha通道。UrlTemplateImageryProvider#ready返回true之前，不应调用此函数。

Default Value: true

readonlymaximumLevel : Number

Scene/UrlTemplateImageryProvider.js 345

获取可以请求的最大级别，如果没有限制，则为未定义。UrlTemplateImageryProvider#ready返回true之前，不应调用此函数。

Default Value: undefined

readonlyminimumLevel : Number

Scene/UrlTemplateImageryProvider.js 363

获取可以请求的最小级别。UrlTemplateImageryProvider#ready返回true之前，不应调用此函数。

Default Value: 0

readonlypickFeaturesUrl : String

Scene/UrlTemplateImageryProvider.js 283

获取用于选择要素的URL模板。如果未指定此属性，则UrlTemplateImageryProvider#pickFeatures将立即返回undefined，表示未选择任何要素。URL模板支持UrlTemplateImageryProvider#url属性支持的所有关键字，以及以下内容：

{i}: 拾取位置的像素列（水平坐标），其中最西端的像素为0
{j}: 拾取位置的像素行（垂直坐标），其中最北端的像素为0
{reverseI}: 拾取位置的像素列（水平坐标），其中最东端的像素为0
{reverseJ}: 拾取位置的像素行（垂直坐标），其中最南端的像素为0
{longitudeDegrees}: 所选位置的经度（以度为单位）
{latitudeDegrees}: 所选位置的纬度（以度为单位）
{longitudeProjected}: 切片方案投影坐标中拾取位置的经度
{latitudeProjected}: 切片方案投影坐标中拾取位置的纬度
{format}: GetFeatureInfoFormat中指定的获取要素信息的格式

readonlyproxy : Proxy

Scene/UrlTemplateImageryProvider.js 296

获取此提供器使用的代理。

Default Value: undefined

readonlyready : Boolean

Scene/UrlTemplateImageryProvider.js 448

获取一个值，该值指示提供器是否已准备好使用。

readonlyreadyPromise : Promise.<Boolean>

Scene/UrlTemplateImageryProvider.js 460

获取一个在提供器准备好使用时解析为true的Promise。

readonlyrectangle : Rectangle

Scene/UrlTemplateImageryProvider.js 399

地图矩形范围。UrlTemplateImageryProvider#ready返回true之前，不应调用此函数。

Default Value: tilingScheme.rectangle

readonlytileDiscardPolicy : TileDiscardPolicy

Scene/UrlTemplateImageryProvider.js 418

获取瓦片忽略策略。如果未定义，则忽略策略负责通过其shouldDiscardImage函数过滤掉“丢失”的瓦片。如果此函数返回未定义，则不过滤任何切片。UrlTemplateImageryProvider＃ready返回true之前，不应调用此函数。

Default Value: undefined

readonlytileHeight : Number

Scene/UrlTemplateImageryProvider.js 327

获取每个瓦片的高度（以像素为单位）。UrlTemplateImageryProvider#ready返回true之前，不应调用此函数。

Default Value: 256

readonlytileWidth : Number

Scene/UrlTemplateImageryProvider.js 309

获取每个瓦片的宽度（以像素为单位）。UrlTemplateImageryProvider#ready返回true之前，不应调用此函数。

Default Value: 256

readonlytilingScheme : TilingScheme

Scene/UrlTemplateImageryProvider.js 381

获取切片方案。UrlTemplateImageryProvider#ready返回true之前，不应调用此函数。

Default Value: new WebMercatorTilingScheme()

readonlyurl : String

Scene/UrlTemplateImageryProvider.js 236

获取用于请求切片的URL模板。它具有以下关键字：

{z}: 级别
{x}: 瓦片X坐标
{y}: 瓦片X坐标
{s}: 可用的子域之一，用于克服浏览器对每个主机的并发请求数的限制
{reverseX}: 瓦片X坐标
{reverseY}: 瓦片X坐标
{reverseZ}: 级别
{westDegrees}: 最小经度
{southDegrees}: 最小纬度
{eastDegrees}: 最大经度
{northDegrees}: 最大纬度
{westProjected}: 切片方案的投影坐标系下的最小X坐标
{southProjected}: 切片方案的投影坐标系下的最小Y坐标
{eastProjected}: 切片方案的投影坐标系下的最大X坐标
{northProjected}: 切片方案的投影坐标系下的最大Y坐标
{width}: 瓦片宽
{height}: 瓦片高

readonlyurlSchemeZeroPadding : Object

Scene/UrlTemplateImageryProvider.js 259

获取每个瓦片坐标的URL方案零填充。格式为'000'，其中每个坐标将在左侧填充0，以匹配传递的0字符串的宽度。例如，设置： urlSchemeZeroPadding : { '{x}' : '0000'}，将导致一个'x'值12返回字符串'0012'为{x}在生成的URL。它传递的对象有以下关键字：

{z}: 在切片方案中瓦片级别的零填充
{x}: 在切片方案中瓦片X坐标的零填充
{y}: 在切片方案中瓦片Y坐标的零填充
{reverseX}: 在切片方案中，瓦片的反转X坐标的零填充
{reverseY}: 在切片方案中，瓦片的反转Y坐标的零填充
{reverseZ}: 在切片方案中，瓦片的反转Z坐标的零填充

内置方法

getTileCredits(x, y, level) → Array.<Credit>

Scene/UrlTemplateImageryProvider.js 574

获取当请求的瓦片被显示出来时，要显示的版权信息。

Name	Type	Description
`x`	Number	瓦片的X坐标。
`y`	Number	瓦片的Y坐标。
`level`	Number	瓦片的层级。

返回值：

返回的版权信息。

异常情况：

DeveloperError : 在图像提供器准备就绪之前，不得调用 getTileCredits 。

pickFeatures(x, y, level, longitude, latitude) → Promise.<Array.<ImageryLayerFeatureInfo>>|undefined

Scene/UrlTemplateImageryProvider.js 621

异步地确定哪些要素（如果有的话）位于瓦片中给定的经度和纬度。在ImageryProvider#ready返回true之前，不应该调用此函数。这个函数是可选的，所以它可能不存在于所有的ImageryProviders上。

Name	Type	Description
`x`	Number	瓦片的X坐标。
`y`	Number	瓦片的Y坐标。
`level`	Number	瓦片的级别。
`longitude`	Number	拾取要素的经度。
`latitude`	Number	拾取要素的纬度。