UrlTemplateImageryProvider

new Cesium.UrlTemplateImageryProvider(options)
engine/Source/Scene/UrlTemplateImageryProvider.js 185

通过使用指定的URL模板请求瓦片来提供影像。
Name Type Description
options UrlTemplateImageryProvider.ConstructorOptions 描述初始化选项的对象
Example:
// Access Natural Earth II imagery, which uses a TMS tiling scheme and Geographic (EPSG:4326) project
const tms = new Cesium.UrlTemplateImageryProvider({
    url : Cesium.buildModuleUrl('Assets/Textures/NaturalEarthII') + '/{z}/{x}/{reverseY}.jpg',
    tilingScheme : new Cesium.GeographicTilingScheme(),
    maximumLevel : 5
});
// Access the CartoDB Positron basemap, which uses an OpenStreetMap-like tiling scheme.
const 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.
const 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.
const custom = new Cesium.UrlTemplateImageryProvider({
   url : 'https://yoururl/{Time}/{z}/{y}/{x}.png',
   customTags : {
       Time: function(imageryProvider, x, y, level) {
           return '20171231'
       }
   }
});
See:

Members

readonly credit : Credit
engine/Source/Scene/UrlTemplateImageryProvider.js 482

获取在此影像提供者激活时显示的信用信息。通常用于标明 影像的来源。
Default Value: undefined

enablePickFeatures : boolean
engine/Source/Scene/UrlTemplateImageryProvider.js 265

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

readonly errorEvent : Event
engine/Source/Scene/UrlTemplateImageryProvider.js 468

获取每当影像提供者遇到异步错误时触发的事件。通过订阅 此事件，您将被通知错误并可能能够从中恢复。事件监听器 会接收一个 TileProviderError 的实例。

readonly hasAlphaChannel : boolean
engine/Source/Scene/UrlTemplateImageryProvider.js 499

获取一个值，指示此影像提供者提供的图像是否包含alpha通道。 如果该属性为false，则如果存在，将忽略alpha通道。如果该属性为true，则任何没有alpha通道的图像 将被视为其alpha在所有地方为1.0。当此属性为false时，内存使用量 和纹理上传时间会减少。
Default Value: true

readonly maximumLevel : number|undefined
engine/Source/Scene/UrlTemplateImageryProvider.js 399

获取可以请求的最大细节级别，如果没有限制则为undefined。
Default Value: undefined

readonly minimumLevel : number
engine/Source/Scene/UrlTemplateImageryProvider.js 412

获取可以请求的最小细节级别。
Default Value: 0

readonly pickFeaturesUrl : string
engine/Source/Scene/UrlTemplateImageryProvider.js 347

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

readonly proxy : Proxy
engine/Source/Scene/UrlTemplateImageryProvider.js 360

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

readonly rectangle : Rectangle
engine/Source/Scene/UrlTemplateImageryProvider.js 439

获取此实例提供的影像的矩形（单位为弧度）。
Default Value: tilingScheme.rectangle

readonly tileDiscardPolicy : TileDiscardPolicy
engine/Source/Scene/UrlTemplateImageryProvider.js 454

获取瓦片丢弃策略。如果不为undefined，则丢弃策略负责 通过其shouldDiscardImage函数过滤掉“缺失”瓦片。如果该函数 返回undefined，则不会过滤任何瓦片。
Default Value: undefined

readonly tileHeight : number
engine/Source/Scene/UrlTemplateImageryProvider.js 386

获取每个瓦片的高度（以像素为单位）。
Default Value: 256

readonly tileWidth : number
engine/Source/Scene/UrlTemplateImageryProvider.js 373

获取每个瓦片的宽度（以像素为单位）。
Default Value: 256

readonly tilingScheme : TilingScheme
engine/Source/Scene/UrlTemplateImageryProvider.js 426

获取此提供者使用的瓦片方案。
Default Value: new WebMercatorTilingScheme()

readonly url : string
engine/Source/Scene/UrlTemplateImageryProvider.js 295

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

readonly urlSchemeZeroPadding : object
engine/Source/Scene/UrlTemplateImageryProvider.js 320

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

Methods

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

获取在显示给定瓦片时要显示的信用信息。
Name Type Description
x number 瓦片的X坐标。
y number 瓦片的Y坐标。
level number 瓦片的级别；
Returns:
显示瓦片时要展示的信用信息。

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

异步确定在给定经度和纬度内的瓦片中是否存在特征（如果有）。
Name Type Description
x number 瓦片的X坐标。
y number 瓦片的Y坐标。
level number 瓦片的级别。
longitude number 要选择特征的经度。
latitude number 要选择特征的纬度。
Returns:
一个关于被选中特征的承诺，当异步选择完成时将解析。解析值是一个 ImageryLayerFeatureInfo 实例的数组。 如果在给定位置没有找到特征，数组可能为空。如果不支持选择，也可能返回undefined。

requestImage(x, y, level, request) → Promise.<ImageryTypes>|undefined
engine/Source/Scene/UrlTemplateImageryProvider.js 527

Name Type Description
x number 瓦片的X坐标。
y number 瓦片的Y坐标。
level number 瓦片的级别。
request Request optional 请求对象。仅用于内部使用。
Returns:
一个图像的承诺，当图像可用时将解析，或者 如果对服务器的活动请求过多，则返回undefined，该请求应在稍后重试。

Type Definitions

Cesium.UrlTemplateImageryProvider.ConstructorOptions
engine/Source/Scene/UrlTemplateImageryProvider.js 51

初始化UrlTemplateImageryProvider构造函数的选项。
Properties:
Name Type Attributes Default Description
url Resource | string 用于请求瓦片的URL模板。它具有以下关键字：
  • {z}: 瓦片在瓦片方案中的级别。零级是四叉树金字塔的根。
  • {x}: 瓦片在瓦片方案中的X坐标，其中0是最西的瓦片。
  • {y}: 瓦片在瓦片方案中的Y坐标，其中0是最北的瓦片。
  • {s}: 可用的子域之一，用于克服每个主机的同时请求数量限制。
  • {reverseX}: 瓦片在瓦片方案中的X坐标，其中0是最东的瓦片。
  • {reverseY}: 瓦片在瓦片方案中的Y坐标，其中0是最南的瓦片。
  • {reverseZ}: 瓦片在瓦片方案中的级别，其中零级是四叉树金字塔的最大级别。使用reverseZ时，必须定义maximumLevel。
  • {westDegrees}: 瓦片在大地度数中的西边缘。
  • {southDegrees}: 瓦片在大地度数中的南边缘。
  • {eastDegrees}: 瓦片在大地度数中的东边缘。
  • {northDegrees}: 瓦片在大地度数中的北边缘。
  • {westProjected}: 瓦片在瓦片方案的投影坐标中的西边缘。
  • {southProjected}: 瓦片在瓦片方案的投影坐标中的南边缘。
  • {eastProjected}: 瓦片在瓦片方案的投影坐标中的东边缘。
  • {northProjected}: 瓦片在瓦片方案的投影坐标中的北边缘。
  • {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'，每个坐标将在左侧用零填充以匹配传递的零字符串的宽度。例如，设置： urlSchemeZeroPadding : { '{x}' : '0000'} 将导致 'x' 值为12时，在生成的URL中 {x} 返回字符串 '0012'。 传递的对象具有以下关键字：
  • {z}: 瓦片在瓦片方案中的级别的零填充。
  • {x}: 瓦片在瓦片方案中的X坐标的零填充。
  • {y}: 瓦片在瓦片方案中的Y坐标的零填充。
  • {reverseX}: 瓦片在瓦片方案中的reverseX坐标的零填充。
  • {reverseY}: 瓦片在瓦片方案中的reverseY坐标的零填充。
  • {reverseZ}: 瓦片在瓦片方案中的reverseZ坐标的零填充。
subdomains string | Array.<string> <optional>
 'abc' 用于URL模板中 {s} 占位符的子域。 如果此参数是一个单独的字符串，则字符串中的每个字符都是一个子域。如果是 数组，则数组中的每个元素都是一个子域。
credit Credit | string <optional>
 '' 数据源的信用信息，将显示在画布上。
minimumLevel number <optional>
 0 影像提供者支持的最小细节级别。指定此时要注意 最小级别的瓦片数量较小，如四个或更少。较大的数量可能会 导致渲染问题。
maximumLevel number <optional>
 影像提供者支持的最大细节级别，如果没有限制，则为undefined。
rectangle Rectangle <optional>
 Rectangle.MAX_VALUE 图像覆盖的矩形（单位为弧度）。
tilingScheme TilingScheme <optional>
 WebMercatorTilingScheme 指定如何将椭球表面划分为瓦片的瓦片方案。 如果未提供此参数，则使用 WebMercatorTilingScheme。
ellipsoid Ellipsoid <optional>
 椭球体。如果指定瓦片方案， 则忽略此参数并使用瓦片方案的椭球体。如果两个参数都未指定，则使用WGS84椭球体。
tileWidth number <optional>
 256 图像瓦片的像素宽度。
tileHeight number <optional>
 256 图像瓦片的像素高度。
hasAlphaChannel boolean <optional>
 true 如果此影像提供者提供的图像 包含alpha通道，则为true；否则为false。如果该属性为false，则如果 alpha通道存在，将被忽略。如果该属性为true，则任何没有alpha通道的图像 将被视为其alpha在所有地方为1.0。当此属性为false时，内存使用量 和纹理上传时间可能会减少。
getFeatureInfoFormats Array.<GetFeatureInfoFormat> <optional>
 在 UrlTemplateImageryProvider#pickFeatures 被调用时，在特定位置获取特征信息的格式。如果未 指定此参数，则禁用特征选择。
enablePickFeatures boolean <optional>
 true 如果为true，则UrlTemplateImageryProvider#pickFeatures将 请求 pickFeaturesUrl 并尝试解释响应中包含的特征。如果为false， UrlTemplateImageryProvider#pickFeatures将立即返回undefined（表示没有可选择的 特征），而不与服务器通信。如果您知道数据 源不支持选择特征，或者不希望该提供者的特征可以选择，则将此属性设置为false。注意 这可以通过修改 UriTemplateImageryProvider#enablePickFeatures 属性动态覆盖。
tileDiscardPolicy TileDiscardPolicy <optional>
 根据某些标准丢弃瓦片图像的策略。
customTags Object <optional>
 允许在URL模板中替换自定义关键字。对象必须具有字符串作为键和函数作为值。
需要帮助？获得答案的最快方法是来自社区和团队 Cesium Forum.
packages/engine
packages/widgets