Class: ImageRenderingRule

// 浏览器
<script type="text/javascript" src="https://iclient.supermap.io/dist/mapboxgl/iclient-mapboxgl.js"></script>
<script>
  new mapboxgl.supermap.ImageRenderingRule(options);
  
  // 弃用的写法
  new SuperMap.ImageRenderingRule(options);

</script>

// ES6 Import
import { ImageRenderingRule } from '@supermapgis/iclient-mapboxgl';

new ImageRenderingRule(options);

Members

(static, readonly) DisplayModestring

影像显示模式。

Properties:

Name	Type	Default	Description
COMPOSITE	string	COMPOSITE	多波段组合显示。
STRETCHED	string	Stretched	单波段拉伸显示。

(static, readonly) InterpolationModestring

影像显示时使用的插值算法枚举。

Properties:

Name	Type	Default	Description
NEARESTNEIGHBOR	string	NEARESTNEIGHBOR	最邻近插值模式。
HIGHQUALITYBILINEAR	string	HIGHQUALITYBILINEAR	高质量的双线性插值模式。
DEFAULT	string	DEFAULT	默认插值模式。

backgroundColorstring

指定背景值的颜色。支持指定 RGB 颜色，例如：255,0,0（红色），那么背景值将以指定的红色显示。

backgroundTransparentboolean

背景值是否透明显示，true 表示透明显示背景值；否则为 false。

backgroundValuestring

影像的背景值。影像为多波段时，通过逗号分隔 R,G,B 颜色通道对应波段的背景值。

brightnessnumber

影像显示的亮度。数值范围为 -100 到 100，增加亮度为正，降低亮度为负。

colorSchemeArray.<string>

影像拉伸显示的颜色方案。颜色方案为 RGBA 颜色数组。RGBA 是代表 Red（红色）Green（绿色）Blue（蓝色）和 Alpha 的色彩空间。Alpha 值可以省略不写，表示完全不透明。Alpha 通道表示不透明度参数，若该值为 0 表示完全透明。例如："255,0,0","0,255,0","0,0,255" 表示由红色、绿色、蓝色三种颜色构成的色带。

colorTableArray.<string>

影像的颜色表。颜色表为栅格值与 RGBA 颜色值的对照表。RGBA 是代表 Red（红色）Green（绿色）Blue（蓝色）和 Alpha 的色彩空间。Alpha 值可以省略不写，表示完全不透明。Alpha 通道表示不透明度参数，若该值为 0 表示完全透明。以下示例表示该颜色对照表由三组构成，第一组高程值为 500，对应的颜色为红色；第二组高程值为 700，对应的颜色为绿色；第三组高程值为 700，对应的颜色为蓝色。示例："500: 255,0,0", "700: 0,255,0" , "900: 0,0,255"。

contrastnumber

影像显示的对比度。数值范围为 -100 到 100，增加对比度为正，降低对比度为负。

displayBandsstring

影像显示的波段或者波段组合。该参数为一个数组，数组元素为波段索引号。若影像的显示模式为 Stretched，该属性指定一个显示的波段；若影像的显示模式为 Composite，该属性为组合的波段索引号，例如：属性值 4,3,2 表示采用 4 波段、3 波段、2 波段分别对应 R、G、B 颜色通道进行组合显示。

displayModeImageRenderingRule.DisplayMode

影像显示模式，其中：Composite 表示多波段组合显示；Stretched 表示单波段拉伸显示。

gammanumber

Gamma 参数，数值范围为 0 到 10，数值精度为小数点后两位。实现影像非线性亮度和对比度调整， 当 Gamma 值等于1时，图像没有进行 Gamma 校正。当 Gamma 值大于1时，图像的暗部区域对比度增加，细节更加突出， 但亮部区域的细节会有所损失，整体图像变亮。当Gamma值小于1时，图像的亮部区域对比度增加，细节更加突出， 但暗部区域的细节会有所损失，整体图像变暗。

gridFunctionsArray.<(ImageGFHillShade|ImageGFSlope|ImageGFAspect|ImageGFOrtho)>

栅格函数选项，通过应用栅格函数，可以对影像进行快速显示处理。

interpolationModeImageRenderingRule.InterpolationMode

影像显示时使用的插值算法。

noDatastring

影像的无值。影像为多波段时，通过逗号分隔 R,G,B 颜色通道对应波段的无值。

noDataColorstring

影像的无值的显示颜色，支持RGB颜色，例如：255,0,0（红色），那么无值将以指定的红色显示。

noDataTransparentboolean

无值是否透明显示，true 表示透明显示无值；否则为 false。

stretchOptionImageStretchOption

影像的拉伸参数。

Methods

constructFromObject(data, obj){ImageRenderingRule}

common/iServer/ImageRenderingRule.js, line 151

目标对象新增该类的可选参数。

Name	Type	Description
data	Object	要转换的数据。
obj	ImageRenderingRule	返回的模型。

Returns:

Type	Description
ImageRenderingRule	返回结果。

destroy()

common/iServer/ImageRenderingRule.js, line 127

释放资源，将引用资源的属性置空。