com.esri.arcgis.carto
Interface IRasterDisplayProps

All Superinterfaces:

Serializable

All Known Implementing Classes:

RasterClassifyColorRampRenderer, RasterColormapRenderer, RasterDiscreteColorRenderer, RasterRGBRenderer, RasterStretchColorRampRenderer, RasterUniqueValueRenderer

public interface IRasterDisplayProps
extends Serializable

Provides access to members that control the raster display properties.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

int	getBrightnessValue() Brightness value for a raster.
int	getContrastValue() Contrast value for a raster.
IColor	getNoDataColor() Nodata color for a raster.
int	getTransparencyValue() Transparency value for a raster.
void	setBrightnessValue(int pValue) Brightness value for a raster.
void	setContrastValue(int iValue) Contrast value for a raster.
void	setNoDataColorByRef(IColor ppColor) Nodata color for a raster.
void	setTransparencyValue(int pValue) Transparency value for a raster.

Method Detail

setContrastValue

void setContrastValue(int iValue)
                      throws IOException,
                             AutomationException

Contrast value for a raster.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

iValue - The iValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContrastValue

int getContrastValue()
                     throws IOException,
                            AutomationException

Contrast value for a raster.

Remarks

The IRasterDisplayProps interface controls display properties common to all raster renderers.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The iValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBrightnessValue

void setBrightnessValue(int pValue)
                        throws IOException,
                               AutomationException

Brightness value for a raster.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

pValue - The pValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBrightnessValue

int getBrightnessValue()
                       throws IOException,
                              AutomationException

Brightness value for a raster.

Remarks

The BrightnessValue property ranges from -100 to 100, representing a percentage of increase or decrease in the property.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The pValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransparencyValue

void setTransparencyValue(int pValue)
                          throws IOException,
                                 AutomationException

Transparency value for a raster.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

pValue - The pValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTransparencyValue

int getTransparencyValue()
                         throws IOException,
                                AutomationException

Transparency value for a raster.

Remarks

The TransparencyValue value ranges from 0 to 100, with 0 representing opaque and 100 representing fully transparent.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The pValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNoDataColor

IColor getNoDataColor()
                      throws IOException,
                             AutomationException

Nodata color for a raster.

Remarks

The NoDataColor property controls how NoData cells in your raster are displayed. By default, NoData cells appear transparent.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNoDataColorByRef

void setNoDataColorByRef(IColor ppColor)
                         throws IOException,
                                AutomationException

Nodata color for a raster.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

ppColor - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.