提供由 Mapbox 托管的瓦片影像。
| Name | Type | Description |
|---|---|---|
options |
MapboxImageryProvider.ConstructorOptions | 描述初始化选项的对象。 |
Example:
// Mapbox tile provider
const mapbox = new Cesium.MapboxImageryProvider({
mapId: 'mapbox.mapbox-terrain-v2',
accessToken: 'thisIsMyAccessToken'
});
See:
Members
readonly credit : Credit
获取当此影像提供器处于活动状态时显示的版权信息。通常这用于标注
影像的来源。
readonly errorEvent : Event
获取当影像提供器遇到异步错误时引发的事件。通过订阅
该事件,你会收到错误通知,并有可能从中恢复。事件监听器
会接收到一个
TileProviderError 实例。
获取一个值,指示此影像提供器所提供的图像
是否包含 alpha 通道。如果此属性为 false,则存在(若有)的 alpha 通道
将被忽略。如果此属性为 true,则任何没有 alpha 通道的图像将被视为
其 alpha 处处为 1.0。当此属性为 false 时,内存占用
和纹理上传时间会减少。
获取可以请求的最大细节级别。
获取可以请求的最小细节级别。通常,
仅当影像的矩形范围足够小、
以至于最小级别处的瓦片数量很少时才应使用最小级别。在最小级别处具有
多个瓦片的影像提供器会导致
渲染问题。
readonly proxy : Proxy
获取此提供器使用的代理。
readonly rectangle : Rectangle
获取此实例所提供影像的矩形范围(以弧度表示)。
readonly tileDiscardPolicy : TileDiscardPolicy
获取瓦片丢弃策略。如果不为 undefined,该丢弃策略负责
通过其 shouldDiscardImage 函数过滤掉“缺失”的瓦片。如果此函数
返回 undefined,则不会过滤任何瓦片。
获取每个瓦片的高度(以像素为单位)。
获取每个瓦片的宽度(以像素为单位)。
readonly tilingScheme : TilingScheme
获取此提供器使用的瓦片方案。
获取 Mapbox 服务器的 URL。
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
异步确定在给定的经度和纬度处、某个瓦片内存在哪些(如果有)要素。
此函数是可选的,因此并非所有 ImageryProvider 上都存在。
| 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
MapboxImageryProvider 构造函数的初始化选项
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
url |
string |
<optional> |
'https://api.mapbox.com/v4/' | Mapbox 服务器 url。 |
mapId |
string | Mapbox 地图 ID。 | ||
accessToken |
string | 影像的公共访问令牌。 | ||
format |
string |
<optional> |
'png' | 图像请求的格式。 |
ellipsoid |
Ellipsoid |
<optional> |
Ellipsoid.default | 椭球体。如果未指定,则使用默认椭球体。 |
minimumLevel |
number |
<optional> |
0 | 影像提供器支持的最小细节级别。指定时请注意, 最小级别处的瓦片数量应较少(例如四个或更少)。数量 较多可能会导致渲染问题。 |
maximumLevel |
number |
<optional> |
影像提供器支持的最大细节级别,如果没有限制则为 undefined。 | |
rectangle |
Rectangle |
<optional> |
Rectangle.MAX_VALUE | 图像覆盖的矩形范围(以弧度表示)。 |
credit |
Credit | string |
<optional> |
数据源的版权信息,显示在画布上。 |
