new MapboxImageryProvider()
提供由 Mapbox 托管的瓦片影像。
| Name | Type | Default | Description |
|---|---|---|---|
options.url |
String | 'https://api.mapbox.com/v4/' |
可选
Mapbox 服务器URL。 |
options.mapId |
String |
Mapbox 地图 ID |
|
options.accessToken |
String |
可选
影像的公共访问令牌。 |
|
options.format |
String | 'png' |
可选
影像请求的格式。 |
options.proxy |
Object |
可选
用于请求的代理。该对象应具有一个 getURL 函数,用于返回代理 URL。 |
|
options.ellipsoid |
Ellipsoid |
可选
椭球。如果未指定,则使用WGS84椭球。 |
|
options.minimumLevel |
Number | 0 |
可选
影像提供商支持的最小精细级别。在指定此选项时,请注意最小级别上的瓦片数量要小,例如4个或更少。较大的数字可能会导致呈现问题。 |
options.maximumLevel |
Number |
可选
影像提供商支持的最大精细级别,如果没有限制,则未定义。 |
|
options.rectangle |
Rectangle | Rectangle.MAX_VALUE |
可选
被影像覆盖的矩形,以弧度为单位。 |
options.credit |
Credit | String |
可选
数据源的版权声明,显示在画布上。 |
- See:
Example
// Mapbox tile provider
var mapbox = new SuperMap3D.MapboxImageryProvider({
mapId: 'mapbox.streets',
accessToken: 'thisIsMyAccessToken'
});
Members
-
readonly creditCredit
-
获取该影像提供者激活时要显示的版权声明。通常用于标明影像来源。 此函数不应在
MapboxImageryProvider#ready返回 true 之前调用。 -
readonly errorEventEvent
-
获取在影像提供程序遇到异步错误时引发的事件。 通过订阅该事件,您将收到错误通知,并有可能从中恢复。 事件侦听器会收到一个
TileProviderError的实例。 -
readonly hasAlphaChannelBoolean
-
获取一个值,该值指示是否由此影像提供程序提供影像包括一个alpha通道。 如果此属性为false,则存在alpha通道被忽略。 如果此属性为true,则任何没有alpha通道的影像都将被处理
-
readonly maximumLevelNumber
-
获取可请求的最大精细程度。在
MapboxImageryProvider#ready返回 true 之前不应调用此函数。 -
readonly minimumLevelNumber
-
获取可请求的最小精细级别。 在
MapboxImageryProvider#ready返回 true 之前不应调用此函数。 一般来说,只有当影像的矩形范围足够小,以至于最小级别的图块数量足够多时,才能使用最小级别。 以至于最小级别的瓦片数量很少时,才应使用最小级别。 如果影像提供器的最小级别瓦片数量超过几个,就会导致渲染问题。 -
readonly proxyProxy
-
获取该提供程序使用的代理。
-
readonly readyBoolean
-
获取表示提供程序是否可以使用的值。
-
readonly readyPromisePromise.<Boolean>
-
获取当提供程序准备就绪时解析为 true 的Promise。
-
readonly rectangleRectangle
-
获取实例所提供影像的矩形(以弧度为单位)。此函数不应在
MapboxImageryProvider#ready返回 true 之前调用。 -
readonly tileDiscardPolicyTileDiscardPolicy
-
获取瓦片丢弃策略。如果未定义,则丢弃策略负责通过其 shouldDiscardImage 函数过滤 "丢失 "的瓦片。 如果此函数返回未定义,则不会过滤任何瓦片。 在
MapboxImageryProvider#ready返回 true 之前,不应调用此函数。 -
readonly tileHeightNumber
-
获取每个瓦片的高度(以像素为单位)。此函数不应在
MapboxImageryProvider#ready返回 true 之前调用。 -
readonly tileWidthNumber
-
获取每个瓦片的宽度(以像素为单位)。此函数不应在
MapboxImageryProvider#ready返回 true 之前调用。 -
readonly tilingSchemeTilingScheme
-
获取提供程序使用的切片方案。此函数不应在
MapboxImageryProvider#ready返回 true 之前调用。 -
readonly urlString
-
获取Mapbox服务器的URL。
Methods
-
getTileCredits(x, y, level){Array.<Credit>}
-
获取显示给定瓦片时要显示的版权声明。
Name Type Description xNumber 瓦片的 X 坐标。
yNumber 瓦片的 y 坐标。
levelNumber 瓦片的级别。
Throws:
-
getTileCredits不得在影像提供程序准备就绪前调用。 - Type
- DeveloperError
Returns:
Type Description Array.<Credit> 显示瓦片时要显示的版权声明。 -
-
pickFeatures(x, y, level, longitude, latitude){Promise.<Array.<ImageryLayerFeatureInfo>>|undefined}
-
异步确定瓦片中给定经度和纬度处的地物(如果有的话)。 在
MapboxImageryProvider#ready返回 true 之前不应调用此函数。 此函数为可选函数,因此并非所有影像提供程序都有此函数。Name Type Description xNumber 瓦片的 X 坐标。
yNumber 瓦片的 y 坐标。
levelNumber 瓦片的级别。
longitudeNumber 选取特征的经度。
latitudeNumber 选取特征的纬度。
Throws:
-
pickFeatures不得在影像提供程序准备就绪前调用。 - Type
- DeveloperError
Returns:
Type Description Promise.<Array.<ImageryLayerFeatureInfo>> | undefined 当异步提取完成时,将解析所提取特征的Promise。 解析值是一个由 ImageryLayerFeatureInfo实例组成的数组。 如果在给定位置没有找到特征,数组可能为空。 如果不支持提取,该数组也可能是未定义的。 -
-
requestImage(x, y, level, request){Promise.<(Image|Canvas)>|undefined}
-
请求指定瓦片的影像。此函数不应在
MapboxImageryProvider#ready返回 true 之前调用。Name Type Description xNumber 瓦片的 X 坐标。
yNumber 瓦片的 y 坐标。
levelNumber 瓦片的级别。
requestRequest 可选 请求对象。仅供内部使用。
Throws:
-
requestImage不得在影像提供程序准备就绪前调用。 - Type
- DeveloperError
Returns:
Type Description Promise.<(Image|Canvas)> | undefined 影像的Promise,该承诺将在影像可用时解析该影像; 如果服务器上有太多请求,则未定义该Promise,请求应稍后重试。 解析的影像可以是影像或 Canvas DOM 对象。 -