Cesium API - MapboxStyleImageryProvider 中文文档

new Cesium.MapboxStyleImageryProvider(options)

提供由Mapbox托管的瓦片图像。

Name Type Description

options

Object

optional 此对象拥有以下属性：

Name	Type	Default	Description
`url`	Resource \| String	`'https://api.mapbox.com/styles/v1/'`	optional Mapbox 服务器 url。
`username`	String	`'mapbox'`	optional 地图账户用户名。
`styleId`	String		Mapbox 样式 ID.
`accessToken`	String		optional 图像的公共访问令牌。
`tilesize`	Number	`512`	optional 瓦片大小。
`scaleFactor`	Boolean		optional 瓦片缩放比例因子。
`ellipsoid`	Ellipsoid		optional 椭球。如果未指定，则使用WGS84椭球。
`minimumLevel`	Number	`0`	optional 图像提供器支持的最低详细程度。指定此值时，请注意最小级别的瓦片数量较小，例如四个或更少。数量较大可能会导致渲染问题。
`maximumLevel`	Number		optional 图像提供器支持的最大级别，如果没有限制，则为未定义。
`rectangle`	Rectangle	`Rectangle.MAX_VALUE`	optional 图层的矩形范围，以弧度表示。
`credit`	Credit \| String		optional 数据源的版权，它显示在画布上。

示例：

// Mapbox 样式提供器。
var mapbox = new Cesium.MapboxStyleImageryProvider({
    styleId: 'streets-v11',
    accessToken: 'thisIsMyAccessToken'
});

参考：

成员变量

readonlycredit : Credit

Scene/MapboxStyleImageryProvider.js 244

获取版权信息。MapboxStyleImageryProvider#ready返回true之前，不应调用此函数。

readonlyerrorEvent : Event

Scene/MapboxStyleImageryProvider.js 232

获取此提供器遇到异步错误时触发的事件。通过订阅事件，您将收到错误通知，并可能从中恢复。事件监听器传递一个TileProviderError的实例。

readonlyhasAlphaChannel : Boolean

Scene/MapboxStyleImageryProvider.js 268

获取影像是否有Alpha通道。

readonlymaximumLevel : Number

Scene/MapboxStyleImageryProvider.js 180

获取可以请求的最大级别。MapboxStyleImageryProvider#ready返回true之前，不应调用此函数。

readonlyminimumLevel : Number

Scene/MapboxStyleImageryProvider.js 194

获取可以请求的最小级别。 MapboxStyleImageryProvider#ready返回true之前，不应调用此函数。通常，只有当图像的矩形足够小，使得最小级别的瓦片数量足够少时，才应该使用最小级别。一个图像提供器如果在最小级别上有多个图像瓦片，就会导致渲染问题。

readonlyproxy : Proxy

Scene/MapboxStyleImageryProvider.js 256

获取此提供器使用的代理。

readonlyready : Boolean

Scene/MapboxStyleImageryProvider.js 120

获取一个值，该值指示提供器是否已准备好使用。

readonlyreadyPromise : Promise.<Boolean>

Scene/MapboxStyleImageryProvider.js 132

获取一个在提供器准备好使用时解析为true的Promise。

readonlyrectangle : Rectangle

Scene/MapboxStyleImageryProvider.js 144

获取要显示的地图范围，以弧度表示。MapboxStyleImageryProvider#ready返回true之前，不应调用此函数。

readonlytileDiscardPolicy : TileDiscardPolicy

Scene/MapboxStyleImageryProvider.js 219

获取瓦片忽略策略。如果未定义，则忽略策略负责通过其shouldDiscardImage函数过滤掉“丢失”的瓦片。如果此函数返回未定义，则不过滤任何切片。MapboxStyleImageryProvider#ready返回true之前，不应调用此函数。

readonlytileHeight : Number

Scene/MapboxStyleImageryProvider.js 168

获取瓦片高。MapboxStyleImageryProvider#ready返回true之前，不应调用此函数。

readonlytileWidth : Number

Scene/MapboxStyleImageryProvider.js 156

获取瓦片宽。MapboxStyleImageryProvider#ready返回true之前，不应调用此函数。

readonlytilingScheme : TilingScheme

Scene/MapboxStyleImageryProvider.js 206

获取切片方案。 MapboxStyleImageryProvider#ready返回true之前，不应调用此函数。

readonlyurl : String

Scene/MapboxStyleImageryProvider.js 108

获取Mapbox服务器url。

内置方法

getTileCredits(x, y, level) → Array.<Credit>

Scene/MapboxStyleImageryProvider.js 285

获取当请求的瓦片被显示出来时，要显示的版权信息。

Name	Type	Description
`x`	Number	瓦片的X坐标。
`y`	Number	瓦片的Y坐标。
`level`	Number	瓦片的层级。

返回值：

返回的版权。

异常情况：

DeveloperError : 在图像提供器准备就绪之前，不得调用 getTileCredits 。

pickFeatures(x, y, level, longitude, latitude) → Promise.<Array.<ImageryLayerFeatureInfo>>|undefined

Scene/MapboxStyleImageryProvider.js 326

异步地确定哪些要素（如果有的话）位于瓦片中给定的经度和纬度。在MapboxStyleImageryProvider#ready返回true之前，不应该调用此函数。这个函数是可选的，所以它可能不存在于所有的ImageryProviders上。

Name	Type	Description
`x`	Number	瓦片的X坐标。
`y`	Number	瓦片的Y坐标。
`level`	Number	瓦片的级别。
`longitude`	Number	拾取要素的经度。
`latitude`	Number	拾取要素的纬度。

返回值：

对所选要素的promise，它将在异步拾取完成时解析。解析后的值是ImageryLayerFeatureInfo实例的数组。如果在给定位置没有发现任何要素，则该数组可能为空。如果不支持拾取，它也可能是未定义的。

异常情况：

DeveloperError : pickFeatures在图像提供器准备好之前不能被调用。

requestImage(x, y, level, request) → Promise.<(Image|Canvas)>|undefined

Scene/MapboxStyleImageryProvider.js 305

请求给定块的瓦片。MapboxStyleImageryProvider#ready返回true之前，不应调用此函数。

Name	Type	Description
`x`	Number	瓦片的X坐标。
`y`	Number	瓦片的Y坐标。
`level`	Number	瓦片的层级。
`request`	Request	optional Request对象（仅供内部使用）。