ImageryLayer - Cesium Documentation

ImageryLayer

new Cesium.ImageryLayer(imageryProvider, options)

影像图层类，用于显示影像提供者的瓦片影像数据。

Name Type Description

imageryProvider SuperMapImageryProvider 指定的影像提供者。

options

Object

optional 对象具有以下属性:

Name	Type	Default	Description
`rectangle`	Rectangle	`imageryProvider.rectangle`	optional 图层的矩形范围,此矩形限制了影像可见范围。
`alpha`	Number \| function	`1.0`	optional 图层透明度值，取值范围为0.0~1.0。
`brightness`	Number \| function	`1.0`	optional 图层亮度值。值为1.0表示使用原图；值大于1.0时图像将变亮；值小于1.0时图像将变暗。
`contrast`	Number \| function	`1.0`	optional 图层对比度。值为1.0表示使用原图；值大于1.0表示增加对比度；值小于1.0表示降低对比度。
`hue`	Number \| function	`0.0`	optional 图层色调。值为0.0表示使用原图。
`saturation`	Number \| function	`1.0`	optional 图层饱和度。值为1.0表示使用原图；值大于1.0表示增加饱和度；值小于1.0表示降低饱和度。
`gamma`	Number \| function	`1.0`	optional 图层伽马校正。值为1.0表示使用原图。
`show`	Boolean	`true`	optional 指定图层是否显示，true表示显示此图层，false表示不显示。
`splitDirection`	ImagerySplitDirection \| function	`ImagerySplitDirection.NONE`	optional 指定影像图层分割方向。
`minimumTerrainLevel`	Number		optional 最小地形细节层次。level 0是最小细节层次。
`maximumTerrainLevel`	Number		optional 最大地形细节层次。

Example:

var  imageryProvider = new Cesium.SuperMapImageryProvider({
		    url : ‘http://localhost:8090/iserver/services/datas/China’
     });
     //通过影像提供者创建影像图层
var imageryLayer = new Cesium.ImageryLayer(imageryProvider);

Members

alpha : Number

图层透明度值，取值范围为0.0~1.0。0.0表示完全透明；1.0表示完全不透明。

Default Value: 1.0

brightness : Number

图层亮度值。值为1.0表示使用原图；值大于1.0时图像将变亮；值小于1.0时图像将变暗。

Default Value: ImageryLayer.DEFAULT_BRIGHTNESS

contrast : Number

图层对比度。值为1.0表示使用原图；值大于1.0表示增加对比度；值小于1.0表示降低对比度。

Default Value: ImageryLayer.DEFAULT_CONTRAST

enableUpsample : Boolean

子tile的影像请求失败时会采用父tile的影像，默认值：true（当四个子tile中只有部分有数据时，可设置为false，防止影像错乱）

gamma : Number

图层伽马校正。值为1.0表示使用原图。

Default Value: ImageryLayer.DEFAULT_GAMMA

hue : Number

图层色调。值为0.0表示使用原图。

Default Value: ImageryLayer.DEFAULT_HUE

indexedDBSetting : Object

获取或者设置影像的indexedDB缓存是否开启(IE浏览器不支持)

Example:

//设置是否保存影像缓存到浏览器的indexedDB数据库
var imageryLayer = viewer.imageryLayers.get(1);
imageryLayer.indexedDBSetting.isOpen = true;

lodOffset : Number

获取或者设置设置加载影像图层时的偏移量。这里的偏移是指细节层次上的偏移，值越大，细节层越往上偏移，加载的影像图层越精细，影像越清晰，值为负时更影像模糊。注：这里的值只能设置为整数。默认值为0，不偏移。

Default Value: 0

saturation : Number

图层饱和度。值为1.0表示使用原图；值大于1.0表示增加饱和度；值小于1.0表示降低饱和度。

Default Value: ImageryLayer.DEFAULT_SATURATION

show : Boolean

指定当前图层是否显示。

Default Value: true

splitDirection : ImagerySplitDirection

指定影像图层分割方向ImagerySplitDirection，可控制影像图层仅在分割条的左边或右边区域显示。

Default Value: ImageryLayer.DEFAULT_SPLIT

swipeEnabled : Boolean

获取或者设置是否开启卷帘功能。

swipeRegion : Rectangle

获取或者设置卷帘的四边形区域。

transparentBackColor : Color

设置影像透明色。

Default Value: ImageryLayer.DEFAULT_TRANSPARENTBACKCOLOR

transparentBackColorTolerance : Number

设置影像透明色容限，取值范围为0.0~1.0。0.0表示完全透明，1.0表示完全不透明。

Default Value: ImageryLayer.DEFAULT_TRANSPARENTBACKCOLORTOLERANCE

Methods

destroy() → undefined

释放对象占用的资源。

Returns:

返回undefined。

Example:

imageryLayer = imageryLayer && imageryLayer.destroy();

See:

ImageryLayer#isDestroyed

getViewableRectangle() → Promise

获取图层的可见范围。

Returns:

矩形对象，表示图层可见范围。

Example:

// Zoom to an imagery layer.
imageryLayer.getViewableRectangle().then(function (rectangle) {
    return camera.flyTo({
        destination: rectangle
    });
});

isBaseLayer() → Boolean

判断该图层是否为影像图层集合ImageryLayerCollection中的基础图层。

基础图层是特殊的，它被视为具有全局矩形。

Returns:

true表示为基础图层; false则为非基础图层。

Example:

var isBaseLayer = imageryLayer.isBaseLayer();

isDestroyed() → Boolean

返回是否释放对象占用的资源。

Returns:

是否释放占用的资源。

See:

ImageryLayer#destroy

setVisibleInViewport(index, visible)

根据索引设置图层对应视口可见性。

Name	Type	Description
`index`	Number	视口的索引
`visible`	Boolean	视口的可见性

Throws:

DeveloperError : the index is 0~3