提供由 OpenStreetMap 或其他 Slippy 切片提供者托管的切片图像的图像提供者。默认 url 连接到 OpenStreetMap 的志愿者运行的服务器,因此您必须遵守他们的
Tile Usage Policy
。
Name | Type | Description |
---|---|---|
options
|
OpenStreetMapImageryProvider.ConstructorOptions | 描述初始化选项的对象 |
Throws:
-
DeveloperError : rectangle 和 minimumLevel 表示最小级别有四个以上的图块。不支持在最低级别具有四个以上图块的图像提供程序。
Example:
const osm = new Cesium.OpenStreetMapImageryProvider({
url : 'https://a.tile.openstreetmap.org/'
});
See:
Extends
Members
readonly credit : Credit
当此图像提供程序处于活动状态时,获得要显示的功劳。通常,这用于说明图像的来源。在
UrlTemplateImageryProvider#ready
返回 true 之前,不应调用此函数。
- Inherited From:
- Default Value:
undefined
此提供程序的默认 alpha 混合值,0.0 表示完全透明,1.0 表示完全不透明。
- Inherited From:
- Default Value:
undefined
此提供程序的默认亮度。 1.0 使用未修改的图像颜色。小于 1.0 会使图像更暗,而大于 1.0 会使图像更亮。
- Inherited From:
- Default Value:
undefined
此提供程序的默认对比度。 1.0 使用未修改的图像颜色。小于 1.0 会降低对比度,而大于 1.0 会增加对比度。
- Inherited From:
- Default Value:
undefined
此提供程序的地球日侧的默认 alpha 混合值,0.0 表示完全透明,1.0 表示完全不透明。
- Inherited From:
- Default Value:
undefined
应用于此提供程序的默认伽马校正。 1.0 使用未修改的图像颜色。
- Inherited From:
- Default Value:
undefined
此提供程序的默认色调(以弧度为单位)。 0.0 使用未修改的图像颜色。
- Inherited From:
- Default Value:
undefined
defaultMagnificationFilter : TextureMagnificationFilter
应用于此提供程序的默认纹理放大过滤器。
- Inherited From:
- Default Value:
undefined
defaultMinificationFilter : TextureMinificationFilter
应用于此提供程序的默认纹理缩小过滤器。
- Inherited From:
- Default Value:
undefined
此提供程序的地球夜晚的默认 alpha 混合值,0.0 表示完全透明,1.0 表示完全不透明。
- Inherited From:
- Default Value:
undefined
此提供程序的默认饱和度。 1.0 使用未修改的图像颜色。小于 1.0 会降低饱和度,而大于 1.0 会增加饱和度。
- 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 通道(如果存在)将被忽略。如果此属性为真,则任何没有 alpha 通道的图像都将被视为其 alpha 在任何地方都是 1.0。当此属性为 false 时,内存使用量和纹理上传时间会减少。在
ImageryProvider#ready
返回 true 之前不应调用此函数。
- Inherited From:
- Default Value:
true
获取可以请求的最大细节级别,如果没有限制,则为 undefined。在
UrlTemplateImageryProvider#ready
返回 true 之前,不应调用此函数。
- Inherited From:
- Default Value:
undefined
获取可以请求的最低详细级别。在
UrlTemplateImageryProvider#ready
返回 true 之前,不应调用此函数。
- 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
获取一个值,该值指示提供程序是否已准备好使用。
- Inherited From:
当提供者准备好使用时,获取一个解析为 true 的承诺。
- Inherited From:
readonly rectangle : Rectangle
获取此实例提供的图像的矩形(以弧度为单位)。在
UrlTemplateImageryProvider#ready
返回 true 之前,不应调用此函数。
- Inherited From:
- Default Value:
tilingScheme.rectangle
readonly tileDiscardPolicy : TileDiscardPolicy
获取瓦片丢弃策略。如果未定义,丢弃策略负责通过其 shouldDiscardImage 函数过滤掉'丢失的'图块。如果此函数返回未定义,则不过滤任何图块。在
UrlTemplateImageryProvider#ready
返回 true 之前,不应调用此函数。
- Inherited From:
- Default Value:
undefined
获取每个图块的高度,以像素为单位。在
UrlTemplateImageryProvider#ready
返回 true 之前,不应调用此函数。
- Inherited From:
- Default Value:
256
获取每个图块的宽度,以像素为单位。在
UrlTemplateImageryProvider#ready
返回 true 之前,不应调用此函数。
- Inherited From:
- Default Value:
256
readonly tilingScheme : TilingScheme
获取此提供程序使用的切片方案。在
UrlTemplateImageryProvider#ready
返回 true 之前,不应调用此函数。
- 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:
显示磁贴时要显示的学分。
Throws:
-
DeveloperError : 在图像提供程序准备好之前,不得调用
getTileCredits
。
- Inherited From:
pickFeatures (x, y, level, longitude, latitude) → Promise.<Array.< ImageryLayerFeatureInfo >>|undefined
异步确定哪些要素(如果有)位于图块内的给定经度和纬度处。在
ImageryProvider#ready
返回 true 之前不应调用此函数。
Name | Type | Description |
---|---|---|
x
|
Number | 平铺 X 坐标。 |
y
|
Number | 瓦片 Y 坐标。 |
level
|
Number | 瓷砖级别。 |
longitude
|
Number | 选择要素的经度。 |
latitude
|
Number | 选择要素的纬度。 |
Returns:
异步拾取完成时将解决的拾取特征的承诺。解析的值是
ImageryLayerFeatureInfo
实例的数组。如果在给定位置未找到任何特征,则该数组可能为空。如果不支持拾取,它也可能是未定义的。
- Inherited From:
重新初始化此实例。支持重新初始化已在使用的实例,但不建议这样做,因为图像提供者提供的现有切片将不会更新。
Name | Type | Description |
---|---|---|
options
|
Promise.<Object> | Object |
可以传递给
UrlTemplateImageryProvider
构造函数的任何选项。
|
- Inherited From:
requestImage (x, y, level, request ) → Promise.< ImageryTypes >|undefined
请求给定图块的图像。在
UrlTemplateImageryProvider#ready
返回 true 之前,不应调用此函数。
Name | Type | Description |
---|---|---|
x
|
Number | 平铺 X 坐标。 |
y
|
Number | 瓦片 Y 坐标。 |
level
|
Number | 瓷砖级别。 |
request
|
Request | 可选 请求对象。仅供内部使用。 |
Returns:
对图像的承诺,当图像可用时将解析,或者如果对服务器的活动请求过多,则未定义,并且应稍后重试请求。
- Inherited From:
Type Definitions
OpenStreetMapImageryProvider 构造函数的初始化选项
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
url
|
String |
<optional>
|
'https://a.tile.openstreetmap.org' | OpenStreetMap 服务器网址。 |
fileExtension
|
String |
<optional>
|
'png' | 服务器上图像的文件扩展名。 |
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' | 数据源的功劳,显示在画布上。 |