提供由 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
获取瓦片丢弃策略。如果不为undefined，则丢弃策略负责
通过其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中 {x} 返回字符串 '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 时，请求 2x 分辨率的图块以适应视网膜显示。 |
rectangle |
Rectangle |
<optional> |
Rectangle.MAX_VALUE | 图层的矩形区域。 |
minimumLevel |
number |
<optional> |
0 | 此影像提供程序支持的最小细节级别。 |
maximumLevel |
number |
<optional> |
此影像提供程序支持的最大细节级别，如果没有限制则为未定义。 | |
ellipsoid |
Ellipsoid |
<optional> |
椭球体。如果未指定，则使用 WGS84 椭球体。 | |
credit |
Credit | string |
<optional> |
'MapQuest, Open Street Map and contributors, CC-BY-SA' | 数据源的信用信息，将显示在画布上。 |