Class: ImageRenderingRule

SuperMap.ImageRenderingRule

定义请求的影像如何进行渲染或者处理，如：影像的拉伸显示方式、颜色表、波段组合以及应用栅格函数进行快速处理等。

new SuperMap.ImageRenderingRule(options)

common/iServer/ImageRenderingRule.js, line 9
Name Type Description
options Object

初始化参数。

Name Type Description
displayMode SuperMap.ImageRenderingRule.DisplayMode 可选

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

影像显示的波段或者波段组合。若影像的显示模式为STRETCHED，该属性指定一个波段的索引号(波段索引号从0开始计数)；若影像的显示模式为COMPOSITE，该属性为组合的波段索引号，例如：属性值3,2,1表示采用4波段、3波段、2波段分别对应 R、G、B颜色通道进行组合显示。
stretchOption SuperMap.ImageStretchOption 可选

影像的拉伸参数。
interpolationMode SuperMap.ImageRenderingRule.InterpolationMode 可选

影像显示时使用的插值算法。
colorScheme Array.<string> 可选

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

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

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

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

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

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

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

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

背景值是否透明显示，true表示透明显示背景值；否则为false。
gridFunctions Array.<(SuperMap.ImageGFHillShade|SuperMap.ImageGFSlope|SuperMap.ImageGFAspect|SuperMap.ImageGFOrtho)> 可选

栅格函数链。

Members

SuperMap.ImageRenderingRule.DisplayModestring

Properties:
Name Type Default Description
COMPOSITE string COMPOSITE
STRETCHED string Stretched

SuperMap.ImageRenderingRule.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颜色通道进行组合显示。

displayModeSuperMap.ImageRenderingRule.DisplayMode

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

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

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

interpolationModeSuperMap.ImageRenderingRule.InterpolationMode

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

noDatastring

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

noDataColorstring

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

noDataTransparentboolean

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

stretchOptionSuperMap.ImageStretchOption

影像的拉伸参数。

Methods

constructFromObject(data, obj){SuperMap.ImageRenderingRule}

common/iServer/ImageRenderingRule.js, line 156
Name Type Description
data Object

要转换的数据.
obj SuperMap.ImageRenderingRule

返回的模型.
Returns:
Type Description
SuperMap.ImageRenderingRule 返回结果

destroy()

common/iServer/ImageRenderingRule.js, line 133

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