UrlTemplateImageryProvider

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

通过使用指定的 URL 模板请求瓦片来提供影像。
Name Type Description
options UrlTemplateImageryProvider.ConstructorOptions 描述初始化选项的对象
Example:
// 访问使用 TMS 平铺方案和地理 (EPSG:4326) 投影的自然地球 II 影像
const tms = new Cesium.UrlTemplateImageryProvider({
    url : Cesium.buildModuleUrl('Assets/Textures/NaturalEarthII') + '/{z}/{x}/{reverseY}.jpg',
    tilingScheme : new Cesium.GeographicTilingScheme(),
    maximumLevel : 5
});
// 访问使用类似 OpenStreetMap 平铺方案的 CartoDB Positron 底图。
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.'
});
// 访问 Web 地图服务 (WMS) 服务器。
const wms = new Cesium.UrlTemplateImageryProvider({
   url : 'https://services.ga.gov.au/gis/services/NM_Hydrology_and_Marine_Points/MapServer/WMSServer?' +
         'tiled=true&transparent=true&format=image%2Fpng&exceptions=application%2Fvnd.ogc.se_xml&' +
         'styles=&service=WMS&version=1.3.0&request=GetMap&' +
         'layers=Bores&crs=EPSG%3A3857&' +
         'bbox={westProjected}%2C{southProjected}%2C{eastProjected}%2C{northProjected}&' +
         'width=256&height=256',
   rectangle : Cesium.Rectangle.fromDegrees(95.0, -55.0, 170.0, -1.0)  // 来自 GetCapabilities EX_GeographicBoundingBox
});
// 在模板 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 476

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

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

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

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

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

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

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

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

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

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

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

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

获取用于拾取要素的 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 355

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

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

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

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

获取瓦片丢弃策略。如果未定义，丢弃策略负责 通过其 shouldDiscardImage 函数过滤掉"缺失"的瓦片。如果此函数 返回 undefined，则不过滤任何瓦片。
Default Value: undefined

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

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

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

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

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

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

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

获取用于请求瓦片的 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 316

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

Methods

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

获取显示给定瓦片时要显示的版权信息。
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 545

异步确定在瓦片内给定经度和纬度处存在哪些要素（如果有）。
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 520

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 中返回字符串 '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>
 椭球体。如果指定了 tilingScheme， 则忽略此参数，改用平铺方案的椭球体。如果两个 参数都未指定，则使用 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 模板中的自定义关键字。该对象必须以字符串作为键，函数作为值。
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.
CtrlK
packages/engine
packages/widgets