TileMapServiceImageryProvider

new Cesium.TileMapServiceImageryProvider(options)
engine/Source/Scene/TileMapServiceImageryProvider.js 76

要构造 TileMapServiceImageryProvider，请调用 TileMapServiceImageryProvider.fromUrl。不要直接调用构造函数。
An imagery provider that provides tiled imagery as generated by MapTiler, GDAL2Tiles, etc.
Name Type Description
options TileMapServiceImageryProvider.ConstructorOptions optional Object describing initialization options
Example:
const tms = await Cesium.TileMapServiceImageryProvider.fromUrl(
   "../images/cesium_maptiler/Cesium_Logo_Color", {
     fileExtension: 'png',
     maximumLevel: 4,
     rectangle: new Cesium.Rectangle(
       Cesium.Math.toRadians(-120.0),
       Cesium.Math.toRadians(20.0),
       Cesium.Math.toRadians(-60.0),
       Cesium.Math.toRadians(40.0))
});
See:

Extends

Members

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

获取当此影像提供器处于活动状态时要显示的版权信息。通常这用于标注 影像的来源。
Inherited From:
Default Value: undefined

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

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

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

获取一个事件，当影像提供器遇到异步错误时触发。通过订阅 该事件，你将收到错误通知并有可能从中恢复。事件监听器 会收到一个 TileProviderError 实例。
Inherited From:

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

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

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

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

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

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

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

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

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

获取此提供器使用的代理。
Inherited From:
Default Value: undefined

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

获取此实例提供的影像矩形范围（以弧度表示）。
Inherited From:
Default Value: tilingScheme.rectangle

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

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

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

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

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

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

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

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

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

获取用于请求瓦片的 URL 模板。它包含以下关键字：
  • {z}: 瓦片在瓦片方案中的层级。0 级是四叉树金字塔的根。
  • {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}: 每个瓦片的高度（以像素为单位）。
Inherited From:

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

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

Methods

static Cesium.TileMapServiceImageryProvider.fromUrl(url, options) → Promise.<TileMapServiceImageryProvider>
engine/Source/Scene/TileMapServiceImageryProvider.js 129

从指定的 url 创建 TileMapServiceImageryProvider。
Name Type Description
url Resource | string 服务器上图像瓦片的路径。
options TileMapServiceImageryProvider.ConstructorOptions optional 描述初始化选项的对象。
Returns:
解析为已创建的 TileMapServiceImageryProvider 的 Promise。
Throws:
  • RuntimeError ：无法在 tilemapresource.xml 中找到预期的瓦片集或 bbox 属性。
  • RuntimeError ：tilemapresource.xml 指定了不支持的 profile 属性。
Example:
const tms = await Cesium.TileMapServiceImageryProvider.fromUrl(
   '../images/cesium_maptiler/Cesium_Logo_Color', {
     fileExtension: 'png',
     maximumLevel: 4,
     rectangle: new Cesium.Rectangle(
       Cesium.Math.toRadians(-120.0),
       Cesium.Math.toRadians(20.0),
       Cesium.Math.toRadians(-60.0),
       Cesium.Math.toRadians(40.0))
});

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

获取显示给定瓦片时要显示的版权信息。
Name Type Description
x number 瓦片的 X 坐标。
y number 瓦片的 Y 坐标。
level number 瓦片层级；
Returns:
显示该瓦片时要显示的版权信息。
Inherited From:

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

异步确定在给定的经度和纬度处、某个瓦片内是否存在要素（如果存在的话）。
Name Type Description
x number 瓦片的 X 坐标。
y number 瓦片的 Y 坐标。
level number 瓦片层级。
longitude number 拾取要素处的经度。
latitude number 拾取要素处的纬度。
Returns:
针对所拾取要素的 Promise，将在异步 拾取完成时解析。解析值是一个 ImageryLayerFeatureInfo 实例数组。如果在给定位置未找到要素，该数组可能为空。 如果不支持拾取，则也可能为 undefined。
Inherited From:

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

Name Type Description
x number 瓦片的 X 坐标。
y number 瓦片的 Y 坐标。
level number 瓦片层级。
request Request optional 请求对象。仅供内部使用。
Returns:
图像的 Promise，在图像可用时解析；如果 对服务器的活动请求过多，则应稍后重试该请求，此时为 undefined。
Inherited From:

Type Definitions

Cesium.TileMapServiceImageryProvider.ConstructorOptions
engine/Source/Scene/TileMapServiceImageryProvider.js 16

TileMapServiceImageryProvider 构造函数的初始化选项
Properties:
Name Type Attributes Default Description
fileExtension string <optional>
 'png' 服务器上图像的的文件扩展名。
credit Credit | string <optional>
 '' 数据源的版权信息，显示在画布上。
minimumLevel number <optional>
 0 影像提供器支持的最小细节层级。指定此项时请注意， 最小层级处的瓦片数量应较小，例如不超过四个。较大的数量很可能 会导致渲染问题。
maximumLevel number <optional>
 影像提供器支持的最大细节层级，如果没有限制则为 undefined。
rectangle Rectangle <optional>
 Rectangle.MAX_VALUE 图像所覆盖的矩形范围（以弧度表示）。
tilingScheme TilingScheme <optional>
 指定椭球面 如何被切分为瓦片的瓦片方案。如果未提供此参数，则使用 WebMercatorTilingScheme。
ellipsoid Ellipsoid <optional>
 椭球体。如果指定了 tilingScheme， 则此参数被忽略，改用瓦片方案的椭球体。如果两者 都未指定，则使用 WGS84 椭球体。
tileWidth number <optional>
 256 图像瓦片的像素宽度。
tileHeight number <optional>
 256 图像瓦片的像素高度。
flipXY boolean <optional>
 旧版本的 gdal2tiles.py 在 tilemapresource.xml 中翻转了 X 和 Y 的值。
tileDiscardPolicy TileDiscardPolicy <optional>
 根据某些条件丢弃瓦片图像的策略。 指定此选项将起到相同的作用，从而允许加载这些不正确的瓦片集。
需要帮助？获取答案的最快方式是在 Cesium 论坛 上向社区和团队提问。
CtrlK
packages/engine
packages/widgets