一个图像层,它在
Globe 上显示来自单个图像提供者的平铺图像数据。
| Name | Type | Description |
|---|---|---|
imageryProvider |
ImageryProvider | optional 要使用的图像提供者。 |
options |
ImageryLayer.ConstructorOptions | optional 描述初始化选项的对象 |
Examples:
// Add an OpenStreetMaps layer
const imageryLayer = new Cesium.ImageryLayer(new Cesium.OpenStreetMapImageryProvider({
url: "https://tile.openstreetmap.org/"
}));
scene.imageryLayers.add(imageryLayer);
// Add Cesium ion's default world imagery layer
const imageryLayer = Cesium.ImageryLayer.fromWorldImagery();
scene.imageryLayers.add(imageryLayer);
// Add a new transparent layer from Cesium ion
const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
imageryLayer.alpha = 0.5;
scene.imageryLayers.add(imageryLayer);
See:
Members
如果在构造时或通过图像提供者未提供,则此值用作颜色转透明的默认阈值。
-
Default Value:
0.004
如果在构造时或通过图像提供者未提供,则此值用作图像层的默认亮度。
此值不会修改图像的亮度。
-
Default Value:
1.0
如果在构造时或通过图像提供者未提供,则此值用作图像层的默认对比度。
此值不会修改图像的对比度。
-
Default Value:
1.0
如果在构造时或通过图像提供者未提供,则此值用作图像层的默认伽玛校正。
此值不会修改图像的伽玛。
-
Default Value:
1.0
如果在构造时或通过图像提供者未提供,则此值用作图像层的默认色调。
此值不会修改图像的色调。
-
Default Value:
0.0
static Cesium.ImageryLayer.DEFAULT_MAGNIFICATION_FILTER : TextureMagnificationFilter
如果在构造时或通过图像提供者未提供,则此值用作图像层的默认纹理放大过滤器。
-
Default Value:
TextureMagnificationFilter.LINEAR
static Cesium.ImageryLayer.DEFAULT_MINIFICATION_FILTER : TextureMinificationFilter
如果在构造时或通过图像提供者未提供,则此值用作图像层的默认纹理最小化过滤器。
-
Default Value:
TextureMinificationFilter.LINEAR
如果在构造时或通过图像提供者未提供,则此值用作图像层的默认饱和度。
此值不会修改图像的饱和度。
-
Default Value:
1.0
static Cesium.ImageryLayer.DEFAULT_SPLIT : SplitDirection
如果在构造时或通过图像提供者未提供,则此值用作图像层的默认分割。
-
Default Value:
SplitDirection.NONE
此图层的 alpha 混合值,0.0 表示完全透明,
1.0 表示完全不透明。
-
Default Value:
1.0
此图层的亮度。 1.0 使用未修改的图像颜色。 小于 1.0
会使图像变暗,而大于 1.0 会使其变亮。
-
Default Value:
ImageryLayer.DEFAULT_BRIGHTNESS
colorToAlpha : Color
应设置为透明的颜色值。
颜色转透明的归一化(0-1)阈值。
此图层的对比度。 1.0 使用未修改的图像颜色。 小于 1.0 会降低
对比度,而大于 1.0 会增加对比度。
-
Default Value:
ImageryLayer.DEFAULT_CONTRAST
cutoutRectangle : Rectangle
此图像层的矩形裁剪区域。
此图层在地球白天侧的 alpha 混合值,0.0 表示完全透明,
1.0 表示完全不透明。只有在
Globe#enableLighting 为 true 时此选项才生效。
-
Default Value:
1.0
应用到此图层的伽玛校正。1.0 使用未修改的图像颜色。
-
Default Value:
ImageryLayer.DEFAULT_GAMMA
此图层的色调(以弧度为单位)。0.0 使用未修改的图像颜色。
-
Default Value:
ImageryLayer.DEFAULT_HUE
readonly imageryProvider : ImageryProvider
获取此图层的图像提供者。在
ImageryLayer#ready 返回 true 之前不应调用此方法。
magnificationFilter : TextureMagnificationFilter
应用于此图层的
TextureMagnificationFilter。
可用的值为 TextureMagnificationFilter.LINEAR(默认)
和 TextureMagnificationFilter.NEAREST。
要生效,必须在添加图像层后立即设置此属性。
一旦纹理加载,就无法更改使用的纹理过滤器。
-
Default Value:
ImageryLayer.DEFAULT_MAGNIFICATION_FILTER
minificationFilter : TextureMinificationFilter
应用于此图层的
TextureMinificationFilter。
可用的值为 TextureMinificationFilter.LINEAR(默认)
和 TextureMinificationFilter.NEAREST。
要生效,必须在添加图像层后立即设置此属性。
一旦纹理加载,就无法更改使用的纹理过滤器。
-
Default Value:
ImageryLayer.DEFAULT_MINIFICATION_FILTER
此图层在地球夜侧的 alpha 混合值,0.0 表示完全透明,
1.0 表示完全不透明。只有在
Globe#enableLighting 为 true 时此选项才生效。
-
Default Value:
1.0
当地形提供者成功创建时返回 true。否则返回 false。
readonly readyEvent : Event.<ImageryLayer.ReadyEventCallback>
获取当图像提供者成功创建时引发的事件。事件监听器
会接收到创建的
ImageryProvider 实例。
readonly rectangle : Rectangle
获取此图层的矩形。如果此矩形小于
ImageryProvider 的矩形,则仅显示图像提供者的一部分。
此图层的饱和度。1.0 使用未修改的图像颜色。 小于 1.0 会降低
饱和度,而大于 1.0 会增加饱和度。
-
Default Value:
ImageryLayer.DEFAULT_SATURATION
确定此图层是否显示。
-
Default Value:
true
splitDirection : SplitDirection
应用于此图层的
SplitDirection。
-
Default Value:
ImageryLayer.DEFAULT_SPLIT
Methods
static Cesium.ImageryLayer.fromProviderAsync(imageryProviderPromise, options) → ImageryLayer
从异步图像提供者创建一个新的图像层。该图层将处理任何异步加载或错误,并在准备好后开始渲染图像层。
| Name | Type | Description |
|---|---|---|
imageryProviderPromise |
Promise.<ImageryProvider> | 一个解析为图像提供者的 Promise |
options |
ImageryLayer.ConstructorOptions | 描述初始化选项的对象 |
Returns:
创建的图像层。
- ImageryLayer.errorEvent
- ImageryLayer.readyEvent
- ImageryLayer.provider
- ImageryLayer.fromWorldImagery
Examples:
// Create a new base layer
const viewer = new Cesium.Viewer("cesiumContainer", {
baseLayer: Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
});
// Add a new transparent layer
const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
imageryLayer.alpha = 0.5;
viewer.imageryLayers.add(imageryLayer);
// Handle loading events
const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
viewer.imageryLayers.add(imageryLayer);
imageryLayer.readyEvent.addEventListener(provider => {
imageryLayer.provider.errorEvent.addEventListener(error => {
alert(`Encountered an error while loading imagery tiles! ${error}`);
});
});
imageryLayer.errorEvent.addEventListener(error => {
alert(`Encountered an error while creating an imagery layer! ${error}`);
});
See:
static Cesium.ImageryLayer.fromWorldImagery(options) → ImageryLayer
为 ion 的默认全球基础图像层创建一个新的图像层,目前为 Bing 地图。该图层将处理任何异步加载或错误,并在准备好后开始渲染图像层。
| Name | Type | Description |
|---|---|---|
options |
ImageryLayer.WorldImageryConstructorOptions | 描述初始化选项的对象 |
Returns:
创建的图像层。
* @example
// Create a new base layer
const viewer = new Cesium.Viewer("cesiumContainer", {
baseLayer: Cesium.ImageryLayer.fromWorldImagery();
});
- ImageryLayer.errorEvent
- ImageryLayer.readyEvent
- ImageryLayer.provider
Examples:
// Add a new transparent layer
const imageryLayer = Cesium.ImageryLayer.fromWorldImagery();
imageryLayer.alpha = 0.5;
viewer.imageryLayers.add(imageryLayer);
// Handle loading events
const imageryLayer = Cesium.ImageryLayer.fromWorldImagery();
viewer.imageryLayers.add(imageryLayer);
imageryLayer.readyEvent.addEventListener(provider => {
imageryLayer.provider.errorEvent.addEventListener(error => {
alert(`Encountered an error while loading imagery tiles! ${error}`);
});
});
imageryLayer.errorEvent.addEventListener(error => {
alert(`Encountered an error while creating an imagery layer! ${error}`);
});
See:
销毁此对象持有的 WebGL 资源。销毁一个对象允许确定性地释放
WebGL 资源,而不是依赖垃圾收集器来销毁此对象。
一旦对象被销毁,就不应再使用;调用除
一旦对象被销毁,就不应再使用;调用除
isDestroyed 之外的任何函数
将导致 DeveloperError 异常。因此,将返回值(undefined)分配给对象,如示例中所示。
Throws:
-
DeveloperError : 此对象已被销毁,即已调用 destroy()。
Example:
imageryLayer = imageryLayer && imageryLayer.destroy();
See:
getImageryRectangle() → Rectangle
计算此图层的矩形与图像提供者的可用性矩形的交集,
生成由此图层可以生成的图像的总体边界。
Returns:
定义此图层可以生成的图像总体边界的矩形。
Example:
// Zoom to an imagery layer.
const imageryRectangle = imageryLayer.getImageryRectangle();
scene.camera.flyTo({
destination: rectangle
});
获取一个值,指示此图层是否为
ImageryLayerCollection 中的基础层。
基础层是指在所有其他图层下方的图层。它是特殊的,因为它被视为具有全球矩形,即使它实际上并不具有,
通过将边缘的纹素拉伸到整个地球来实现。
Returns:
如果这是基础层,则返回 true;否则返回 false。
Returns:
如果此对象已被销毁,则返回 true;否则返回 false。
See:
Type Definitions
ImageryLayer 构造函数的初始化选项。
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
rectangle |
Rectangle |
<optional> |
imageryProvider.rectangle | 图层的矩形。此矩形 可以限制图像提供器的可见部分。 |
alpha |
number | function |
<optional> |
1.0 | 此图层的 alpha 混合值,从 0.0 到 1.0。
这可以是一个简单的数字,也可以是具有以下签名的函数
function(frameState, layer, x, y, level)。该函数接收当前帧状态、该图层以及
要求 alpha 的图像瓦片的 x、y 和 level 坐标,并返回
用于该瓦片的 alpha 值。 |
nightAlpha |
number | function |
<optional> |
1.0 | 此图层在地球夜侧的 alpha 混合值,从 0.0 到 1.0。
这可以是一个简单的数字,也可以是具有以下签名的函数
function(frameState, layer, x, y, level)。该函数接收当前帧状态、该图层以及
要求 alpha 的图像瓦片的 x、y 和 level 坐标,并返回
用于该瓦片的 alpha 值。此选项仅在 enableLighting 为 true 时生效。 |
dayAlpha |
number | function |
<optional> |
1.0 | 此图层在地球白天侧的 alpha 混合值,从 0.0 到 1.0。
这可以是一个简单的数字,也可以是具有以下签名的函数
function(frameState, layer, x, y, level)。该函数接收当前帧状态、该图层以及
要求 alpha 的图像瓦片的 x、y 和 level 坐标,并返回
用于该瓦片的 alpha 值。此选项仅在 enableLighting 为 true 时生效。 |
brightness |
number | function |
<optional> |
1.0 | 此图层的亮度。1.0 使用未修改的图像
颜色。小于 1.0 会使图像变暗,而大于 1.0 会使其变亮。
这可以是一个简单的数字,也可以是具有以下签名的函数
function(frameState, layer, x, y, level)。该函数接收当前帧状态、该图层以及
要求亮度的图像瓦片的 x、y 和 level 坐标,并返回
用于该瓦片的亮度值。该函数对每一帧和每一个瓦片进行执行,因此必须快速。 |
contrast |
number | function |
<optional> |
1.0 | 此图层的对比度。1.0 使用未修改的图像颜色。
小于 1.0 会降低对比度,而大于 1.0 会增加对比度。
这可以是一个简单的数字,也可以是具有以下签名的函数
function(frameState, layer, x, y, level)。该函数接收当前帧状态、该图层以及
要求对比度的图像瓦片的 x、y 和 level 坐标,并返回
用于该瓦片的对比度值。该函数对每一帧和每一个瓦片进行执行,因此必须快速。 |
hue |
number | function |
<optional> |
0.0 | 此图层的色调。0.0 使用未修改的图像颜色。
这可以是一个简单的数字,也可以是具有以下签名的函数
function(frameState, layer, x, y, level)。该函数接收当前帧状态、该图层以及
要求色调的图像瓦片的 x、y 和 level 坐标,并返回
用于该瓦片的色调值。该函数对每一帧和每一个瓦片进行执行,因此必须快速。 |
saturation |
number | function |
<optional> |
1.0 | 此图层的饱和度。1.0 使用未修改的图像颜色。
小于 1.0 会降低饱和度,而大于 1.0 会增加饱和度。
这可以是一个简单的数字,也可以是具有以下签名的函数
function(frameState, layer, x, y, level)。该函数接收当前帧状态、该图层以及
要求饱和度的图像瓦片的 x、y 和 level 坐标,并返回
用于该瓦片的饱和度值。该函数对每一帧和每一个瓦片进行执行,因此必须快速。 |
gamma |
number | function |
<optional> |
1.0 | 此图层应用的伽玛校正。1.0 使用未修改的图像颜色。
这可以是一个简单的数字,也可以是具有以下签名的函数
function(frameState, layer, x, y, level)。该函数接收当前帧状态、该图层以及
要求伽玛的图像瓦片的 x、y 和 level 坐标,并返回
用于该瓦片的伽玛值。该函数对每一帧和每一个瓦片进行执行,因此必须快速。 |
splitDirection |
SplitDirection | function |
<optional> |
SplitDirection.NONE | 应用于此图层的 SplitDirection 分割。 |
minificationFilter |
TextureMinificationFilter |
<optional> |
TextureMinificationFilter.LINEAR | 要应用于此图层的
纹理最小化过滤器。可用的值为 TextureMinificationFilter.LINEAR 和
TextureMinificationFilter.NEAREST。 |
magnificationFilter |
TextureMagnificationFilter |
<optional> |
TextureMagnificationFilter.LINEAR | 要应用于此图层的
纹理放大过滤器。可用的值为 TextureMagnificationFilter.LINEAR 和
TextureMagnificationFilter.NEAREST。 |
show |
boolean |
<optional> |
true | 如果图层可见,则为 true;否则为 false。 |
maximumAnisotropy |
number |
<optional> |
maximum supported | 用于纹理过滤的最大各向异性级别。 如果未指定此参数,将使用 WebGL 堆栈支持的最大各向异性。更大的值会使图像在地平线视图中看起来更好。 |
minimumTerrainLevel |
number |
<optional> |
显示此图像层的最小地形细节级别,或未定义以在所有级别显示。 级别零是最不详细的级别。 | |
maximumTerrainLevel |
number |
<optional> |
显示此图像层的最大地形细节级别,或未定义以在所有级别显示。 级别零是最不详细的级别。 | |
cutoutRectangle |
Rectangle |
<optional> |
用于剪切此 ImageryLayer 部分的地理矩形。 | |
colorToAlpha |
Color |
<optional> |
用作 alpha 的颜色。 | |
colorToAlphaThreshold |
number |
<optional> |
0.004 | 用于颜色转透明的阈值。 |
发生错误时调用的函数。
This:
| Name | Type | Description |
|---|---|---|
err |
Error | 一个包含有关发生的错误的详细信息的对象。 |
当提供者被创建时调用的函数。
This:
| Name | Type | Description |
|---|---|---|
provider |
ImageryProvider | 创建的图像提供者。 |
用于 ImageryLayer.fromWorldImagery 的初始化选项
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
options.style |
IonWorldImageryStyle |
<optional> |
IonWorldImageryStyle | 基础图像的样式,目前仅支持 AERIAL、AERIAL_WITH_LABELS 和 ROAD。 |
