提供由 OpenStreetMap 托管的瓦片影像的影像提供程序，
或另一个 Slippy 瓦片提供程序。默认 URL 连接到 OpenStreetMap 的志愿者运行的
服务器，因此您必须遵守其
瓦片使用政策。
| Name | Type | Description |
|---|---|---|
options |
OpenStreetMapImageryProvider.ConstructorOptions | 描述初始化选项的对象 |
Throws:
-
DeveloperError : 范围和最小级别表明最小级别有超过四个瓦片。不支持在最小级别有超过四个瓦片的影像提供程序。
Example:
const osm = new Cesium.OpenStreetMapImageryProvider({
url : 'https://tile.openstreetmap.org/'
});See:
Extends
Members
readonly credit : Credit
获取当此影像提供者激活时显示的版权信息。通常用于注明
影像的来源。
- Inherited From:
- Default Value:
undefined
获取或设置一个值，该值指示是否启用要素拾取。如果为 true，
UrlTemplateImageryProvider#pickFeatures 将
请求 options.pickFeaturesUrl 并尝试解释响应中包含的要素。如果为 false，
UrlTemplateImageryProvider#pickFeatures 将立即返回 undefined（表示没有可拾取的
要素）而不与服务器通信。如果您知道数据源不支持拾取要素或不想
让此提供者的要素可拾取，请将此属性设置为 false。
- Inherited From:
- Default Value:
true
readonly errorEvent : Event
获取当影像提供者遇到异步错误时引发的事件。通过订阅
该事件，您将收到错误通知并可能从中恢复。事件监听器
将接收一个
TileProviderError 实例。
- Inherited From:
获取一个值，该值指示此影像提供者提供的图像是否
包含 alpha 通道。如果此属性为 false，alpha 通道（如果存在）将被
忽略。如果此属性为 true，任何没有 alpha 通道的图像将被视为
其 alpha 值处处为 1.0。当此属性为 false 时，内存使用
和纹理上传时间会减少。
- Inherited From:
- Default Value:
true
获取可以请求的最大细节层级，如果没有限制则为 undefined。
- Inherited From:
- Default Value:
undefined
获取可以请求的最小细节层级。
- Inherited From:
- Default Value:
0
获取用于拾取要素的 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
获取此提供者使用的代理。
- Inherited From:
- Default Value:
undefined
readonly rectangle : Rectangle
获取此实例提供的影像的矩形区域，单位为弧度。
- Inherited From:
- Default Value:
tilingScheme.rectangle
readonly tileDiscardPolicy : TileDiscardPolicy
获取瓦片丢弃策略。如果未定义，丢弃策略负责
通过其 shouldDiscardImage 函数过滤掉"缺失"的瓦片。如果此函数
返回 undefined，则不过滤任何瓦片。
- Inherited From:
- Default Value:
undefined
获取每个瓦片的高度，单位为像素。
- Inherited From:
- Default Value:
256
获取每个瓦片的宽度，单位为像素。
- Inherited From:
- Default Value:
256
readonly tilingScheme : TilingScheme
获取此提供者使用的平铺方案。
- Inherited From:
- Default Value:
new WebMercatorTilingScheme()
获取用于请求瓦片的 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}：每个瓦片的高度，单位为像素。
- Inherited From:
获取每个瓦片坐标的 URL 方案零填充。格式为 '000'，其中每个坐标将在左侧
填充零以匹配传入的零字符串的宽度。例如，设置：
urlSchemeZeroPadding : { '{x}' : '0000'}
将使 x 值 12 在生成的 URL 中返回字符串 '0012'。
它包含以下关键字：
-
{z}：瓦片在平铺方案中层级的零填充。 -
{x}：瓦片在平铺方案中 X 坐标的零填充。 -
{y}：瓦片在平铺方案中 Y 坐标的零填充。 -
{reverseX}：瓦片在平铺方案中 reverseX 坐标的零填充。 -
{reverseY}：瓦片在平铺方案中 reverseY 坐标的零填充。 -
{reverseZ}：瓦片在平铺方案中 reverseZ 坐标的零填充。
- Inherited From:
Methods
getTileCredits(x, y, level) → Array.<Credit>
获取显示给定瓦片时要显示的版权信息。
| Name | Type | Description |
|---|---|---|
x |
number | 瓦片的 X 坐标。 |
y |
number | 瓦片的 Y 坐标。 |
level |
number | 瓦片的层级。 |
Returns:
显示瓦片时要显示的版权信息。
- Inherited From:
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:
拾取要素的承诺，将在异步
拾取完成时解析。解析的值是
ImageryLayerFeatureInfo
实例的数组。如果在给定位置未找到要素，数组可能为空。
如果不支持拾取，也可能为 undefined。
- Inherited From:
requestImage(x, y, level, request) → Promise.<ImageryTypes>|undefined
| Name | Type | Description |
|---|---|---|
x |
number | 瓦片的 X 坐标。 |
y |
number | 瓦片的 Y 坐标。 |
level |
number | 瓦片的层级。 |
request |
Request | optional 请求对象。仅供内部使用。 |
Returns:
瓦片图像的承诺，将在图像可用时解析，或者
如果向服务器的活动请求过多，则返回 undefined，请求应稍后重试。
- Inherited From:
Type Definitions
OpenStreetMapImageryProvider 构造函数的初始化选项
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
url |
string |
<optional> |
'https://tile.openstreetmap.org' | OpenStreetMap 服务器 URL。 |
fileExtension |
string |
<optional> |
'png' | 服务器上图像的文件扩展名。 |
retinaTiles |
boolean |
<optional> |
false | 为 true 时，以 2 倍分辨率为视网膜显示屏请求瓦片。 |
rectangle |
Rectangle |
<optional> |
Rectangle.MAX_VALUE | 图层范围。 |
minimumLevel |
number |
<optional> |
0 | 影像提供程序支持的最小细节级别。 |
maximumLevel |
number |
<optional> |
影像提供程序支持的最大细节级别，如果没有限制则为 undefined。 | |
ellipsoid |
Ellipsoid |
<optional> |
椭球体。如果未指定，则使用 WGS84 椭球体。 | |
credit |
Credit | string |
<optional> |
'MapQuest, Open Street Map and contributors, CC-BY-SA' | 数据源的版权信息，显示在画布上。 |