显示来自单个影像提供商的平铺影像数据的图像图层
在
Globe
上。
Name | Type | Description |
---|---|---|
imageryProvider |
ImageryProvider | optional The imagery provider to use. |
options |
ImageryLayer.ConstructorOptions | optional An 描述初始化选项的对象 |
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
如果未提供颜色到 Alpha 的默认阈值,则此值将用作
在施工期间或由影像提供商提供。
-
Default Value:
0.004
如果在构建过程中未提供图像图层的默认亮度,则此值将用作图像图层的默认亮度
或由图像提供商提供。此值不会修改影像的亮度。
-
Default Value:
1.0
如果在构建过程中未提供图像图层的默认对比度,则此值将用作图像图层的默认对比度
或由图像提供商提供。此值不会修改影像的对比度。
-
Default Value:
1.0
如果在构建过程中未提供影像图层,则此值将用作影像图层的默认灰度系数
或由图像提供商提供。此值不会修改影像的 Gamma。
-
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
应设置为 transparent 的颜色值。
颜色到 Alpha 的标准化 (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
要应用于此图层的 Gamma 校正。 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
的 TextureMinificationFilter.NEAREST} 中。
要生效,必须在添加影像图层后立即设置此属性。
加载纹理后,将无法更改使用的纹理过滤器。
-
Default Value:
ImageryLayer.DEFAULT_MINIFICATION_FILTER
此图层在地球的夜间一侧的 Alpha 混合值,其中 0.0 表示完全透明,并且
1.0 表示完全不透明。这仅在
Globe#enableLighting
为 true
时生效。
-
Default Value:
1.0
成功创建 terrain 提供程序后返回 true。否则,返回 false。
readonly readyEvent : Event.<ImageryLayer.ReadyEventCallback>
获取在成功创建影像提供程序时引发的事件。事件侦听器
将传递创建的
ImageryProvider
实例。
readonly rectangle : Rectangle
获取此层的矩形。 如果此矩形小于
ImageryProvider
,则仅显示影像提供程序的一部分。
此图层的饱和度。1.0 使用未修改的图像颜色。小于 1.0 会降低
饱和度 大于 1.0 时,饱和度会增加 Saturation。
-
Default Value:
ImageryLayer.DEFAULT_SATURATION
确定是否显示此图层。
-
Default Value:
true
splitDirection : SplitDirection
The
SplitDirection
to apply to this layer.
-
Default Value:
ImageryLayer.DEFAULT_SPLIT
Methods
static Cesium.ImageryLayer.fromProviderAsync(imageryProviderPromise, options) → ImageryLayer
从异步影像提供商创建新的影像图层。该图层将处理任何异步加载或错误,并在准备就绪后开始渲染影像图层。
Name | Type | Description |
---|---|---|
imageryProviderPromise |
Promise.<ImageryProvider> | 解析为图像提供商的 Promise |
options |
ImageryLayer.ConstructorOptions | optional 描述初始化选项的对象 |
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
的 ImageryLayerCollection} 中。 Base Layer 是所有
别人。 它的特殊之处在于,即使
实际上并非如此,方法是将边缘的纹素拉伸到整个
球。
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 且应返回的图像模块
用于图块的 Alpha 值。 |
nightAlpha |
number | function |
<optional> |
1.0 | 此图层在地球的夜间一侧的 Alpha 混合值,从 0.0 到 1.0。
这可以是一个简单的数字,也可以是带有签名的函数
function(frameState, layer, x, y, level) 的 该函数将
当前帧状态、此图层以及
需要 Alpha 且应返回的图像模块
用于图块的 Alpha 值。这仅在 enableLighting 为 true 时生效。 |
dayAlpha |
number | function |
<optional> |
1.0 | 此图层在地球的昼侧的 Alpha 混合值,从 0.0 到 1.0。
这可以是一个简单的数字,也可以是带有签名的函数
function(frameState, layer, x, y, level) 的 该函数将
当前帧状态、此图层以及
需要 Alpha 且应返回的图像模块
用于图块的 Alpha 值。这仅在 enableLighting 为 true 时生效。 |
brightness |
number | function |
<optional> |
1.0 | 该图层的亮度。 1.0 使用未修改的图像
颜色。 小于 1.0 会使图像更暗,而大于 1.0 会使图像更亮。
这可以是一个简单的数字,也可以是带有签名的函数
function(frameState, layer, x, y, level) 的 该函数将
当前帧状态、此图层以及
需要亮度且应返回的图像模块
用于图块的亮度值。 该函数对每个
帧和每个图块,因此它必须很快。 |
contrast |
number | function |
<optional> |
1.0 | 该层的对比度。 1.0 使用未修改的图像颜色。
小于 1.0 会降低对比度,而大于 1.0 会增加对比度。
这可以是一个简单的数字,也可以是带有签名的函数
function(frameState, layer, x, y, level) 的 该函数将
当前帧状态、此图层以及
需要对比度且应返回的图像模块
用于磁贴的 contrast 值。 该函数对每个
帧和每个图块,因此它必须很快。 |
hue |
number | function |
<optional> |
0.0 | 该图层的色调。 0.0 使用未修改的影像颜色。
这可以是一个简单的数字,也可以是带有签名的函数
function(frameState, layer, x, y, level) 的 该函数将
当前帧状态、此图层以及 X、Y 和 Level 坐标
需要色调的图像图块,并且它应返回
用于磁贴的 contrast 值。 该函数对每个
帧和每个图块,因此它必须很快。 |
saturation |
number | function |
<optional> |
1.0 | 该层的饱和度。 1.0 使用未修改的图像颜色。
小于 1.0 会降低饱和度,而大于 1.0 会增加饱和度。
这可以是一个简单的数字,也可以是带有签名的函数
function(frameState, layer, x, y, level) 的 该函数将
当前帧状态、此图层以及 X、Y 和 Level 坐标
需要饱和度的影像瓦片,并且应返回
用于磁贴的 contrast 值。 该函数对每个
帧和每个图块,因此它必须很快。 |
gamma |
number | function |
<optional> |
1.0 | 要应用于此图层的 Gamma 校正。 1.0 使用未修改的图像颜色。
这可以是一个简单的数字,也可以是带有签名的函数
function(frameState, layer, x, y, level) 的 该函数将
当前帧状态、此图层以及
需要 Gamma 且应返回的图像模块
用于图块的 Gamma 值。 该函数对每个
帧和每个图块,因此它必须很快。 |
splitDirection |
SplitDirection | function |
<optional> |
SplitDirection.NONE | 要应用于此图层的 SplitDirection 分割。 |
minificationFilter |
TextureMinificationFilter |
<optional> |
TextureMinificationFilter.LINEAR | 的
纹理缩小滤镜以应用于此图层。可能的值
是 TextureMinificationFilter.LINEAR 和
TextureMinificationFilter.NEAREST的 TextureMinificationFilter.NEAREST。 |
magnificationFilter |
TextureMagnificationFilter |
<optional> |
TextureMagnificationFilter.LINEAR | 的
纹理缩小滤镜以应用于此图层。可能的值
是 TextureMagnificationFilter.LINEAR 和
TextureMagnificationFilter.NEAREST的 TextureMagnificationFilter.NEAREST. |
show |
boolean |
<optional> |
true | 如果显示图层,则为 True;否则为 false。 |
maximumAnisotropy |
number |
<optional> |
maximum supported | 要使用的最大各向异性级别 用于纹理筛选。 如果未指定此参数,则支持的最大各向异性 将使用 WebGL 堆栈。 较大的值会使影像在地平线中看起来更好 视图。 |
minimumTerrainLevel |
number |
<optional> |
显示此图像图层的最小地形细节级别, 或 undefined 在所有级别显示它。 级别 0 是最不详细的级别。 | |
maximumTerrainLevel |
number |
<optional> |
显示此图像图层的最大地形细节级别, 或 undefined 在所有级别显示它。 级别 0 是最不详细的级别。 | |
cutoutRectangle |
Rectangle |
<optional> |
用于剪切此 ImageryLayer 的一部分的制图矩形。 | |
要用作 |
Color | Alpha 的 [colorToAlpha] 颜色。 | ||
colorToAlphaThreshold |
number |
<optional> |
0.004 | 颜色到 Alpha 的阈值。 |
发生错误时调用的函数。
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。 |