UrlTemplateImageryProvider

new Cesium.UrlTemplateImageryProvider(options)

通过使用指定的 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://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)  // From GetCapabilities EX_GeographicBoundingBox
});
// 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

获取此影像提供程序处于活动状态时要显示的点数。 通常,这用于贷记 图像的来源。
Default Value: undefined
获取或设置一个值,该值指示是否启用功能选取。 如果为 true,则 UrlTemplateImageryProvider#pickFeatures 将 请求 options.pickFeaturesUrl 并尝试解释响应中包含的功能。 如果为 false,则 UrlTemplateImageryProvider#pickFeatures 将立即返回 undefined(表示没有可选取的) 功能),而无需与服务器通信。 如果您知道您的数据,请将此属性设置为 false Source 不支持选取功能,或者您不希望此提供程序的功能可选取。
Default Value: true
获取在影像提供程序遇到异步错误时引发的事件。 通过订阅 时,您将收到错误通知,并可能从中恢复。 事件侦听器 将传递 TileProviderError 的实例。

readonly hasAlphaChannel : boolean

获取一个值,该值指示此图像提供程序是否提供图像 包括 Alpha 通道。 如果此属性为 false,则 Alpha 通道(如果存在)将 被忽略。 如果此属性为 true,则将处理任何没有 Alpha 通道的图像 就好像它们的 alpha 在所有地方都是 1.0 一样。 当此属性为 false 时,内存使用情况 和纹理上传时间缩短。
Default Value: true

readonly maximumLevel : number|undefined

获取可请求的最大详细级别,如果没有限制,则为 undefined。
Default Value: undefined
获取可请求的最小详细级别。
Default Value: 0

readonly pickFeaturesUrl : string

获取用于选取功能的 URL 模板。 如果未指定此属性, UrlTemplateImageryProvider#pickFeatures 将立即返回 undefined,表示没有 精选功能。 URL 模板支持 UrlTemplateImageryProvider#url 属性,以及以下内容:
  • {i}:选取位置的像素列(水平坐标),其中最西端的像素为 0。
  • {j}:选取位置的像素行(垂直坐标),其中最北端的像素为 0。
  • {reverseI}:选取位置的像素列(水平坐标),其中最东端的像素为 0。
  • {reverseJ}:选取位置的像素行(垂直坐标),其中最南端的像素为 0。
  • {longitudeDegrees}:选取位置的经度(以度为单位)。
  • {latitudeDegrees}:选取位置的纬度(以度为单位)。
  • {longitudeProjected}:切片方案的投影坐标中选取的位置的经度。
  • {latitudeProjected}:切片方案的投影坐标中选取的位置的纬度。
  • {format}:用于获取特征信息的格式,在 GetFeatureInfoFormat 中指定。
获取此提供程序使用的代理。
Default Value: undefined
获取此实例提供的图像的矩形(以弧度为单位)。
Default Value: tilingScheme.rectangle
获取瓦片丢弃策略。 如果未 undefined,则 discard 策略负责 用于通过其 shouldDiscardImage 函数过滤掉“缺失”的瓦片。 如果此功能 返回 undefined,不过滤任何图块。
Default Value: undefined
获取每个图块的高度(以像素为单位)。
Default Value: 256
获取每个图块的宽度(以像素为单位)。
Default Value: 256
获取此提供程序使用的切片方案。
Default Value: new WebMercatorTilingScheme()
获取用于请求磁贴的 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

获取每个图块坐标的 URL 方案零填充。格式为 '000',其中每个坐标都将填充 左侧带有 0 以匹配传递的 0 字符串的宽度。例如:设置: 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>

获取在显示给定磁贴时要显示的制作者名单。
Name Type Description
x number 瓦片 X 坐标。
y number 瓦片 Y 坐标。
level number 瓦片级别;
Returns:
显示磁贴时要显示的制作者名单。

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

异步确定哪些要素(如果有)位于给定的经度和纬度 一个图块。
Name Type Description
x number 瓦片 X 坐标。
y number 瓦片 Y 坐标。
level number 瓦片级别。
longitude number 选取特征的经度。
latitude number 选取特征的纬度。
Returns:
对所选特征的 Promise,当异步 拣选完成。 解析的值是 ImageryLayerFeatureInfo 的数组 实例。 如果在给定位置未找到要素,则数组可能为空。 如果不支持拣选,也可能为 undefined。

requestImage(x, y, level, request)Promise.<ImageryTypes>|undefined

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

Type Definitions

Cesium.UrlTemplateImageryProvider.ConstructorOptions

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}:切片方案中切片的级别,其中级别 0 是四叉树金字塔的最大级别。 要使用 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 图像提供商支持的最低细节层次。 指定时要小心 最低级别的图块数量很少,例如 4 个或更少。 可能更大的数字 导致渲染问题。
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 true(如果此图像提供程序提供的图像) true 包括 Alpha 通道;否则为 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 Source 不支持选取功能,或者您不希望此提供程序的功能可选取。注意 这可以通过修改 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.