提供由 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
获取瓦片丢弃策略。如果未定义,丢弃策略负责
通过其 shouldDiscardImage 函数过滤掉“丢失”的瓦片。如果此函数
返回未定义,则不过滤任何瓦片。
获取每个瓦片的高度(以像素为单位)。
获取每个瓦片的宽度(以像素为单位)。
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
异步确定在给定经度和纬度内的瓦片上是否存在特征(如果有)。
该函数是可选的,因此可能并非所有 ImageryProviders 都存在此函数。
| Name | Type | Description |
|---|---|---|
x |
number | 瓦片的 X 坐标。 |
y |
number | 瓦片的 Y 坐标。 |
level |
number | 瓦片级别。 |
longitude |
number | 要选择特征的经度。 |
latitude |
number | 要选择特征的纬度。 |
Returns:
选择的特征的承诺,当异步选择完成时将解决。
解析值是
ImageryLayerFeatureInfo 实例的数组。如果在给定位置未找到特征,
数组可能为空。如果不支持选择,则可能未定义。
requestImage(x, y, level, request) → Promise.<ImageryTypes>|undefined
请求给定瓦片的图像。
| Name | Type | Description |
|---|---|---|
x |
number | 瓦片的 X 坐标。 |
y |
number | 瓦片的 Y 坐标。 |
level |
number | 瓦片级别。 |
request |
Request | optional 请求对象。仅供内部使用。 |
Returns:
图像的承诺,当图像可用时将解决,或者
如果对服务器的活动请求过多,则返回未定义,请求应稍后重试。
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> |
图像提供者支持的最大细节级别,或者如果没有限制则为未定义。 | |
rectangle |
Rectangle |
<optional> |
Rectangle.MAX_VALUE | 图像覆盖的矩形区域(以弧度表示)。 |
credit |
Credit | string |
<optional> |
数据源的授权信息,将显示在画布上。 |
