MapboxStyleImageryProvider

new Cesium.MapboxStyleImageryProvider (options)

提供由Mapbox托管的平铺图像。
Name Type Description
options MapboxStyleImageryProvider.ConstructorOptions 描述初始化选项的对象
Example:
// Mapbox style provider
var mapbox = new Cesium.MapboxStyleImageryProvider({
    styleId: 'streets-v11',
    accessToken: 'thisIsMyAccessToken'
});
See:

Members

获取此图像提供者处于活动状态时要显示的功劳。通常,这用于记入图像的来源。该功能应在 MapboxStyleImageryProvider#ready 返回true之前不会被调用。

defaultAlpha : Number|undefined

此提供程序的默认alpha混合值,其中0.0表示完全透明,1.0表示完全不透明。
Default Value: undefined

defaultBrightness : Number|undefined

此提供程序的默认亮度。 1.0使用未修改的图像颜色。小于1.0使图像更暗,而大于1.0则使图像更亮。
Default Value: undefined

defaultContrast : Number|undefined

此提供程序的默认对比。 1.0使用未修改的图像颜色。小于1.0减少大于1.0时,对比度增加。
Default Value: undefined

defaultDayAlpha : Number|undefined

此提供程序的全球日期的默认alpha混合值,其中0.0表示完全透明,1.0表示完全不透明。
Default Value: undefined

defaultGamma : Number|undefined

适用于此提供程序的默认伽玛校正。 1.0使用未修改的图像颜色。
Default Value: undefined

defaultHue : Number|undefined

此提供程序的默认色调(以弧度为单位)。 0.0使用未修改的图像颜色。
Default Value: undefined
应用于该提供程序的默认纹理放大滤镜。
Default Value: undefined
应用于该提供程序的默认纹理缩小过滤器。
Default Value: undefined

defaultNightAlpha : Number|undefined

此提供程序的地球仪夜间的默认alpha混合值,其中0.0表示完全透明,1.0表示完全不透明。
Default Value: undefined

defaultSaturation : Number|undefined

此提供程序的默认饱和度。 1.0使用未修改的图像颜色。小于1.0会降低饱和度大于1.0时会增加饱和度。
Default Value: undefined
获取当图像提供程序遇到异步错误时引发的事件。针对该事件,您将收到有关该错误的通知,并有可能从中恢复。事件监听器传递了 TileProviderError 的实例。

readonly hasAlphaChannel : Boolean

获取一个值,该值指示此图像提供者是否提供了图像包括一个Alpha通道。如果此属性为false,则Alpha通道(如果存在)将被忽略。如果此属性为true,则将处理任何没有alpha通道的图像好像他们的alpha到处都是1.0。当此属性为false时,内存使用情况并且减少了纹理上载时间。

readonly maximumLevel : Number|undefined

获取可以请求的最大详细程度。该功能应在 MapboxStyleImageryProvider#ready 返回true之前不会被调用。

readonly minimumLevel : Number

获取可以请求的最低详细程度。该功能应在 MapboxStyleImageryProvider#ready 返回true之前不会被调用。通常,最低级别仅应在图像的矩形较小时使用足以使最低级别的图块数量很小。图像提供者在最低级别上具有多个图块的情况将导致渲染问题。
获取此提供程序使用的代理。
获取一个值,该值指示提供者是否已准备好使用。

readonly readyPromise : Promise.<Boolean>

获取一个在提供程序准备好使用时解析为true的承诺。
获取实例提供的图像的矩形(以弧度表示)。该功能应在 MapboxStyleImageryProvider#ready 返回true之前不会被调用。
获取切片丢弃策略。如果未定义,则丢弃策略负责用于通过其shouldDiscardImage函数过滤掉'缺失'的图块。如果这个功能返回未定义,不过滤任何图块。该功能应在 MapboxStyleImageryProvider#ready 返回true之前不会被调用。

readonly tileHeight : Number

获取每个图块的高度,以像素为单位。该功能应在 MapboxStyleImageryProvider#ready 返回true之前不会被调用。
获取每个图块的宽度,以像素为单位。该功能应在 MapboxStyleImageryProvider#ready 返回true之前不会被调用。
获取提供程序使用的切片方案。该功能应在 MapboxStyleImageryProvider#ready 返回true之前不会被调用。
获取Mapbox服务器的URL。

Methods

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

获取显示给定图块时要显示的信用。
Name Type Description
x Number 瓦片X坐标。
y Number 瓷砖的Y坐标。
level Number 平铺级别;
Returns:
显示图块时要显示的积分。
Throws:
  • DeveloperError : getTileCredits 影像提供者准备就绪之前,不得调用它。

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

异步确定哪些要素(如果有)位于给定的经度和纬度内瓷砖。在 MapboxStyleImageryProvider#ready 返回true之前,不应调用此函数。此功能是可选的,因此可能并非在所有ImageryProviders上都存在。
Name Type Description
x Number 瓦片X坐标。
y Number 瓷砖的Y坐标。
level Number 平铺级别。
longitude Number 选择要素的经度。
latitude Number 选择要素的纬度。
Returns:
对所选择功能的承诺将在异步时解决 采摘完成。解析值是一个数组 ImageryLayerFeatureInfo 实例。如果在给定位置找不到要素,则数组可能为空。 如果不支持拣配,则它也可能是未定义的。
Throws:
  • DeveloperError : pickFeatures 影像提供者准备就绪之前,不得调用它。

requestImage (x, y, level, request ) Promise.<(HTMLImageElement|HTMLCanvasElement)>|undefined

请求给定图块的图像。该功能应在 MapboxStyleImageryProvider#ready 返回true之前不会被调用。
Name Type Description
x Number 瓦片X坐标。
y Number 瓷砖的Y坐标。
level Number 平铺级别。
request Request 可选 请求对象。仅供内部使用。
Returns:
对图像的承诺,将在图像可用时解决,或者 如果对服务器的活动请求过多,并且请求过多,则不确定 应稍后重试。解析的图像可能是 图片或Canvas DOM对象。
Throws:
  • DeveloperError : requestImage 影像提供者准备就绪之前,不得调用它。

Type Definitions

Cesium.MapboxStyleImageryProvider.ConstructorOptions

MapboxStyleImageryProvider构造函数的初始化选项
Properties:
Name Type Attributes Default Description
url Resource | String <optional>
'https://api.mapbox.com/styles/v1/' Mapbox服务器网址。
username String <optional>
'mapbox' 地图帐户的用户名。
styleId String 地图框样式ID。
accessToken String 图像的公共访问令牌。
tilesize Number <optional>
512 图像图块的大小。
scaleFactor Boolean <optional>
确定图块是否以@ 2x比例因子渲染。
ellipsoid Ellipsoid <optional>
椭球。如果未指定,则使用WGS84椭球。
minimumLevel Number <optional>
0 图像提供商所支持的最低详细程度。指定时要小心 这表示最低级别的图块数量很小,例如四个或更少。可能数量更大 导致渲染问题。
maximumLevel Number <optional>
图像提供者支持的最大详细程度,如果没有限制,则未定义。
rectangle Rectangle <optional>
Rectangle.MAX_VALUE 图像所覆盖的矩形(以弧度表示)。
credit Credit | String <optional>
数据源的信用,显示在画布上。