MapboxStyleImageryProvider

new Cesium.MapboxStyleImageryProvider (options)

提供由 Mapbox 托管的平铺图像。
Name Type Description
options MapboxStyleImageryProvider.ConstructorOptions 描述初始化选项的对象
Example:
// Mapbox style provider
const 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 通道(如果存在)将被忽略。如果此属性为真,则任何没有 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.< ImageryTypes >|undefined

请求给定图块的图像。在 MapboxStyleImageryProvider#ready 返回 true 之前不应调用此函数。
Name Type Description
x Number 平铺 X 坐标。
y Number 瓦片 Y 坐标。
level Number 瓷砖级别。
request Request 可选 请求对象。仅供内部使用。
Returns:
对图像的承诺,当图像可用时将解析,或者如果对服务器的活动请求过多,则未定义,并且应稍后重试请求。
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 Mapbox 样式 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>
数据源的功劳,显示在画布上。