UrlTemplateImageryProvider

new Cesium.UrlTemplateImageryProvider ( options )
Scene/UrlTemplateImageryProvider.js 207

通过使用指定的URL模板请求图块来提供图像。
Name Type Description
options Promise.<Object> | Object optional Object with the following properties:
Name Type Default Description
url Resource | String 用于请求图块的URL模板。它具有以下关键字:
  • {z} :切片方案中切片的级别。零级是四叉树金字塔的根。
  • {x} :切片方案中的图块X坐标，其中0是最西端的图块。
  • {y} :切片方案中的图块Y坐标，其中0是最北的图块。
  • {s} :可用的子域之一，用于克服浏览器对每个主机的同时请求数的限制。
  • {reverseX} :切片方案中的图块X坐标，其中0是最东的图块。
  • {reverseY} :切片方案中的图块Y坐标，其中0是最南端的图块。
  • {reverseZ} :切片方案中切片的级别，其中级别0是四叉树金字塔的最大级别。为了使用reverseZ，必须定义maximumLevel。
  • {westDegrees} :瓷砖在测地角度上的西边缘。
  • {southDegrees} :瓷砖在测地角度上的南边缘。
  • {eastDegrees} :以大地测量度表示的图块的东边缘。
  • {northDegrees} :瓷砖在测量角度上的北边缘。
  • {westProjected} :图块方案的投影坐标中图块的西边缘。
  • {southProjected} :在平铺方案的投影坐标中，图块的南边缘。
  • {eastProjected} :图块方案的投影坐标中图块的东边缘。
  • {northProjected} :图块方案的投影坐标中图块的北边缘。
  • {width} :每个图块的宽度（以像素为单位）。
  • {height} :每个图块的高度（以像素为单位）。
pickFeaturesUrl Resource | String 可选 用于选择功能的URL模板。如果未指定此属性， UrlTemplateImageryProvider＃pickFeatures 会立即返回undefined，表示没有                功能选择。网址模板支持 url 支持的所有关键字                参数，以及以下内容:
  • {i} :所选位置的像素列（水平坐标），其中最西端的像素为0。
  • {j} :所选位置的像素行（垂直坐标），其中最北端的像素为0。
  • {reverseI} :所选位置的像素列（水平坐标），其中最东端的像素为0。
  • {reverseJ} :所选位置的像素行（垂直坐标），其中最南端的像素为0。
  • {longitudeDegrees} :所选位置的经度（以度为单位）。
  • {latitudeDegrees} :所选位置的纬度（以度为单位）。
  • {longitudeProjected} :在平铺方案的投影坐标中所拾取位置的经度。
  • {latitudeProjected} :在平铺方案的投影坐标中所拾取位置的纬度。
  • {format} :获取功能信息的格式，如 GetFeatureInfoFormat 中所指定。
urlSchemeZeroPadding Object 可选 获取每个图块坐标的URL方案零填充。格式为' 000'，其中每个坐标将在左侧用零填充，以匹配传递的零字符串的宽度。例如设置:urlSchemeZeroPadding:{'{x}':'0000'}将导致'x'值为12，以在生成的URL中返回{x}的字符串'0012'。传递的对象具有以下关键字:
  • {z} :切片方案中图块级别的零填充。
  • {x} :切片方案中图块X坐标的零填充。
  • {y} :切片方案中图块Y坐标的零填充。
  • {reverseX} :在平铺方案中图块reverseX坐标的零填充。
  • {reverseY} :平铺方案中图块的反向Y坐标的零填充。
  • {reverseZ} :在切片方案中，图块的reverseZ坐标的零填充。
subdomains String | Array.<String> 'abc' 可选 URL模板中用于 {s} 占位符的子域。                         如果此参数是单个字符串，则字符串中的每个字符都是一个子域。如果是                         一个数组，数组中的每个元素都是一个子域。
credit Credit | String '' 可选 数据源的信用，显示在画布上。
minimumLevel Number 0 可选 图像提供者支持的最低详细程度。指定时要小心                这表示最低级别的图块数量很小，例如四个或更少。可能数量更大                导致渲染问题。
maximumLevel Number 可选 图像提供程序支持的最大详细程度，如果没有限制，则为未定义。
rectangle Rectangle Rectangle.MAX_VALUE 可选 图像所覆盖的矩形（以弧度表示）。
tilingScheme TilingScheme WebMercatorTilingScheme 可选 平铺方案指定椭圆形表面碎成瓷砖。如果未提供此参数，则 WebMercatorTilingScheme 使用。
ellipsoid Ellipsoid 可选 椭球。如果指定了tilingScheme，                   忽略此参数，而是使用切片方案的椭球。如果两者都不                   参数，则使用WGS84椭球。
tileWidth Number 256 可选 图像图块的像素宽度。
tileHeight Number 256 可选 图像图块的像素高度。
hasAlphaChannel Boolean true 可选 如果此图像提供者提供的图像为true                 包括一个Alpha通道；否则为假。如果此属性为false，则为Alpha通道，如果                 目前，将被忽略。如果此属性为true，则任何没有Alpha通道的图像都会                 它们的alpha随处可见。当此属性为false时，内存使用情况                 和纹理上传时间可能会减少。
getFeatureInfoFormats Array.< GetFeatureInfoFormat > 可选 在某处获取功能信息的格式                                调用 UrlTemplateImageryProvider＃pickFeatures 时的特定位置。如果这                                参数未指定，功能选择已禁用。
enablePickFeatures Boolean true 可选 如果为true，则 UrlTemplateImageryProvider＃pickFeatures 请求 options.pickFeaturesUrl 并尝试解释响应中包含的功能。如果为假， UrlTemplateImageryProvider＃pickFeatures 会立即返回未定义（表示没有可拾取的内容）       功能）而无需与服务器通信。如果您知道数据，则将此属性设置为false       源不支持选择功能，或者您不希望该提供程序的功能可供选择。注意       可以通过修改 UriTemplateImageryProvider＃enablePickFeatures 来动态覆盖       属性。
customTags Object 可选 允许替换URL模板中的自定义关键字。该对象必须具有字符串作为键，并且必须具有作为值的功能。
Example: 
// Access Natural Earth II imagery, which uses a TMS tiling scheme and Geographic (EPSG:4326) project
var tms = new Cesium.UrlTemplateImageryProvider({
    url : 'https://cesiumjs.org/tilesets/imagery/naturalearthii/{z}/{x}/{reverseY}.jpg',
    credit : '© Analytical Graphics, Inc.',
    tilingScheme : new Cesium.GeographicTilingScheme(),
    maximumLevel : 5
});
// Access the CartoDB Positron basemap, which uses an OpenStreetMap-like tiling scheme.
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.'
});
// Access a Web Map Service (WMS) server.
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)
});
// Using custom tags in your template url.
var custom = new Cesium.UrlTemplateImageryProvider({
   url : 'https://yoururl/{Time}/{z}/{y}/{x}.png',
   customTags : {
       Time: function(imageryProvider, x, y, level) {
           return '20171231'
       }
   }
});
See:
翻译by:http://cesium.xin

Members

readonly credit : Credit
Scene/UrlTemplateImageryProvider.js 525

获取此图像提供者处于活动状态时要显示的功劳。通常，这用于记入图像的来源。在 UrlTemplateImageryProvider＃ready 返回true之前，不应调用此函数。
Default Value: undefined

enablePickFeatures : Boolean
Scene/UrlTemplateImageryProvider.js 244

获取或设置一个值，该值指示是否启用了特征拾取。如果为true，则 UrlTemplateImageryProvider＃pickFeatures 请求 options.pickFeaturesUrl 并尝试解释响应中包含的功能。如果为假， UrlTemplateImageryProvider＃pickFeatures 会立即返回未定义（表示没有可拾取的内容）功能）而无需与服务器通信。如果您知道数据，则将此属性设置为false源不支持选择功能，或者您不希望该提供程序的功能可供选择。
Default Value: true

readonly errorEvent : Event
Scene/UrlTemplateImageryProvider.js 487

获取当图像提供程序遇到异步错误时引发的事件。通过订阅事件发生后，您将收到有关该错误的通知，并有可能从中恢复。事件监听器传递了 TileProviderError 的实例。

readonly hasAlphaChannel : Boolean
Scene/UrlTemplateImageryProvider.js 548

获取一个值，该值指示此图像提供者是否提供了图像包括一个Alpha通道。如果此属性为false，则Alpha通道（如果存在）将被忽略。如果此属性为true，则将处理没有alpha通道的任何图像好像他们的alpha到处都是1.0。当此属性为false时，内存使用情况并且减少了纹理上载时间。该功能应在 ImageryProvider＃ready 返回true之前不会被调用。
Default Value: true

readonly maximumLevel : Number
Scene/UrlTemplateImageryProvider.js 390

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

readonly minimumLevel : Number
Scene/UrlTemplateImageryProvider.js 409

获取可以请求的最低详细程度。该功能应在 UrlTemplateImageryProvider＃ready 返回true之前不会被调用。
Default Value: 0

readonly pickFeaturesUrl : String
Scene/UrlTemplateImageryProvider.js 325

获取用于选择特征的URL模板。如果未指定此属性， UrlTemplateImageryProvider＃pickFeatures 会立即返回undefined，表示没有功能选择。该网址模板支持该广告系列支持的所有关键字 UrlTemplateImageryProvider＃url 属性，以及以下内容:
  • {i} :所选位置的像素列（水平坐标），其中最西端的像素为0。
  • {j} :所选位置的像素行（垂直坐标），其中最北端的像素为0。
  • {reverseI} :所选位置的像素列（水平坐标），其中最东端的像素为0。
  • {reverseJ} :所选位置的像素行（垂直坐标），其中最南端的像素为0。
  • {longitudeDegrees} :所选位置的经度（以度为单位）。
  • {latitudeDegrees} :所选位置的纬度（以度为单位）。
  • {longitudeProjected} :在平铺方案的投影坐标中所拾取位置的经度。
  • {latitudeProjected} :在平铺方案的投影坐标中所拾取位置的纬度。
  • {format} :获取功能信息的格式，如 GetFeatureInfoFormat 中所指定。

readonly proxy : Proxy
Scene/UrlTemplateImageryProvider.js 338

获取此提供程序使用的代理。
Default Value: undefined

readonly ready : Boolean
Scene/UrlTemplateImageryProvider.js 499

获取一个值，该值指示提供程序是否准备就绪。

readonly readyPromise : Promise.<Boolean>
Scene/UrlTemplateImageryProvider.js 511

获取一个在提供程序准备好使用时解析为true的承诺。

readonly rectangle : Rectangle
Scene/UrlTemplateImageryProvider.js 447

获取此实例提供的图像的矩形（以弧度表示）。该功能应在 UrlTemplateImageryProvider＃ready 返回true之前不会被调用。
Default Value: tilingScheme.rectangle

readonly tileDiscardPolicy : TileDiscardPolicy
Scene/UrlTemplateImageryProvider.js 468

获取切片丢弃策略。如果未定义，则丢弃策略负责用于通过其shouldDiscardImage函数过滤掉'缺失'的图块。如果这个功能返回未定义，不过滤任何图块。该功能应在 UrlTemplateImageryProvider＃ready 返回true之前不会被调用。
Default Value: undefined

readonly tileHeight : Number
Scene/UrlTemplateImageryProvider.js 371

获取每个图块的高度，以像素为单位。该功能应在 UrlTemplateImageryProvider＃ready 返回true之前不会被调用。
Default Value: 256

readonly tileWidth : Number
Scene/UrlTemplateImageryProvider.js 352

获取每个图块的宽度，以像素为单位。该功能应在 UrlTemplateImageryProvider＃ready 返回true之前不会被调用。
Default Value: 256

readonly tilingScheme : TilingScheme
Scene/UrlTemplateImageryProvider.js 428

获取此提供程序使用的切片方案。该功能应在 UrlTemplateImageryProvider＃ready 返回true之前不会被调用。
Default Value: new WebMercatorTilingScheme()

readonly url : String
Scene/UrlTemplateImageryProvider.js 275

获取用于请求图块的URL模板。它具有以下关键字:
  • {z} :切片方案中切片的级别。零级是四叉树金字塔的根。
  • {x} :切片方案中的图块X坐标，其中0是最西端的图块。
  • {y} :切片方案中的图块Y坐标，其中0是最北的图块。
  • {s} :可用的子域之一，用于克服浏览器对每个主机的同时请求数的限制。
  • {reverseX} :切片方案中的图块X坐标，其中0是最东的图块。
  • {reverseY} :切片方案中的图块Y坐标，其中0是最南端的图块。
  • {reverseZ} :切片方案中切片的级别，其中级别0是四叉树金字塔的最大级别。为了使用reverseZ，必须定义maximumLevel。
  • {westDegrees} :瓷砖在测地角度上的西边缘。
  • {southDegrees} :瓷砖在测地角度上的南边缘。
  • {eastDegrees} :图块的东边缘，以大地坐标为单位。
  • {northDegrees} :瓷砖在测地角度上的北边缘。
  • {westProjected} :图块方案的投影坐标中图块的西边缘。
  • {southProjected} :图块方案的投影坐标中图块的南边缘。
  • {eastProjected} :图块方案的投影坐标中图块的东边缘。
  • {northProjected} :图块方案的投影坐标中图块的北边缘。
  • {width} :每个图块的宽度（以像素为单位）。
  • {height} :每个图块的高度（以像素为单位）。

readonly urlSchemeZeroPadding : Object
Scene/UrlTemplateImageryProvider.js 299

获取每个图块坐标的URL方案零填充。格式为' 000'，其中每个坐标都将被填充左边的零与传递的零字符串的宽度匹配。例如设置:urlSchemeZeroPadding:{'{x}':'0000'}将导致'x'值为12，以在生成的URL中返回{x}的字符串'0012'。它具有以下关键字:
  • {z} :切片方案中图块级别的零填充。
  • {x} :切片方案中图块X坐标的零填充。
  • {y} :切片方案中图块Y坐标的零填充。
  • {reverseX} :在平铺方案中图块reverseX坐标的零填充。
  • {reverseY} :平铺方案中图块的反向Y坐标的零填充。
  • {reverseZ} :在切片方案中，图块的reverseZ坐标的零填充。

Methods

getTileCredits (x, y, level) → Array.< Credit >
Scene/UrlTemplateImageryProvider.js 632

获取显示给定图块时要显示的积分。
Name Type Description
x Number 瓦片X坐标。
y Number 瓷砖的Y坐标。
level Number 平铺级别；
Returns:
显示图块时要显示的积分。
Throws:
  • DeveloperError : getTileCredits 影像提供者准备就绪之前，不得调用它。

pickFeatures (x, y, level, longitude, latitude) → Promise.<Array.< ImageryLayerFeatureInfo >>|undefined
Scene/UrlTemplateImageryProvider.js 677

异步确定哪些要素（如果有）位于给定的经度和纬度内瓷砖。在 ImageryProvider＃ready 返回true之前，不应调用此函数。
Name Type Description
x Number 瓦片X坐标。
y Number 瓷砖的Y坐标。
level Number 平铺级别。
longitude Number 选择要素的经度。
latitude Number 选择要素的纬度。
Returns:
对所选择功能的承诺将在异步时解决                  采摘完成。解析的值是一个数组 ImageryLayerFeatureInfo 实例。如果在给定位置找不到要素，则数组可能为空。                  如果不支持拣配，则它也可能是未定义的。

reinitialize (options)
Scene/UrlTemplateImageryProvider.js 566

重新初始化该实例。支持重新初始化已在使用的实例，但不支持推荐使用，因为图像提供商提供的现有图块将不会更新。
Name Type Description
options Promise.<Object> | Object 可以传递给 UrlTemplateImageryProvider 构造函数的任何选项。

requestImage (x, y, level, request ) → Promise.<(Image|Canvas)>|undefined
Scene/UrlTemplateImageryProvider.js 654

请求给定图块的图像。该功能应在 UrlTemplateImageryProvider＃ready 返回true之前不会被调用。
Name Type Description
x Number 瓦片X坐标。
y Number 瓷砖的Y坐标。
level Number 平铺级别。
request Request 可选 请求对象。仅供内部使用。
Returns:
对图像的承诺，将在图像可用时解决，或者         如果对服务器的活动请求过多，并且请求过多，则不确定         应稍后重试。解析的图像可能是         图片或Canvas DOM对象。