com.esri.arcgis.carto
Interface IRasterDefaultsEnv5

All Superinterfaces:

IRasterDefaultsEnv, IRasterDefaultsEnv2, IRasterDefaultsEnv3, IRasterDefaultsEnv4, Serializable

All Known Subinterfaces:

IRasterDefaultsEnv6, IRasterDefaultsEnv7

All Known Implementing Classes:

IRasterDefaultsEnv5Proxy, IRasterDefaultsEnv6Proxy, RasterDefaultsEnv

public interface IRasterDefaultsEnv5
extends IRasterDefaultsEnv4, Serializable

Provides access to members that control the default raster environment.

Product Availability

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

Method Summary

IColor	getBackgroundColor() The color of background.
IColor	getNoDataColor() Nodata color for a raster layer.
boolean	isCreateTiledTIFF() Indicates if newly created TIFF images should be tiled.
boolean	isDisplayBackground() Indicates if a background value is being used.
void	queryBackgroundValues(double[] pRed, double[] pGreen, double[] pBlue) background value.
void	setBackgroundColor(IColor ppColor) The color of background.
void	setBackgroundValues(double red, double green, double blue) background value.
void	setCreateTiledTIFF(boolean pTiled) Indicates if newly created TIFF images should be tiled.
void	setDisplayBackground(boolean b) Indicates if a background value is being used.
void	setNoDataColor(IColor ppColor) Nodata color for a raster layer.

Methods inherited from interface com.esri.arcgis.carto.IRasterDefaultsEnv4

getMaximumRastersColorMatching, isAskSubdatasetSelection, isDisplayWithContrastStretch, setAskSubdatasetSelection, setDisplayWithContrastStretch, setMaximumRastersColorMatching

Methods inherited from interface com.esri.arcgis.carto.IRasterDefaultsEnv3

getMaximumBuildAttributeTableSize, isAssumeHomogeneousCatalog, isFavorWorldFile, setAssumeHomogeneousCatalog, setFavorWorldFile, setMaximumBuildAttributeTableSize

Methods inherited from interface com.esri.arcgis.carto.IRasterDefaultsEnv2

getMaxTableSize, getProxyFilePath, getRenderingMode, getResampling, setMaxTableSize, setProxyFilePath, setRenderingMode, setResampling, updateAll

Methods inherited from interface com.esri.arcgis.carto.IRasterDefaultsEnv

getFormat, getNumFormats, getPyramidCreateOpt, isUseExtChecking, query3BandRGB, query4BandRGB, set3BandRGB, set4BandRGB, setPyramidCreateOpt, setUseExtChecking

Method Detail

setDisplayBackground

void setDisplayBackground(boolean b)
                          throws IOException,
                                 AutomationException

Indicates if a background value is being used.

Product Availability

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

Parameters:

b - The b (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDisplayBackground

boolean isDisplayBackground()
                            throws IOException,
                                   AutomationException

Indicates if a background value is being used.

Product Availability

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

Returns:

The b

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryBackgroundValues

void queryBackgroundValues(double[] pRed,
                           double[] pGreen,
                           double[] pBlue)
                           throws IOException,
                                  AutomationException

background value.

Product Availability

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

Parameters:

pRed - The pRed (out: use single element array)

pGreen - The pGreen (out: use single element array)

pBlue - The pBlue (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackgroundValues

void setBackgroundValues(double red,
                         double green,
                         double blue)
                         throws IOException,
                                AutomationException

background value.

Product Availability

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

Parameters:

red - The red (in)

green - The green (in)

blue - The blue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

IColor getBackgroundColor()
                          throws IOException,
                                 AutomationException

The color of background.

Product Availability

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

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.

setBackgroundColor

void setBackgroundColor(IColor ppColor)
                        throws IOException,
                               AutomationException

The color of background.

Product Availability

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

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.

getNoDataColor

IColor getNoDataColor()
                      throws IOException,
                             AutomationException

Nodata color for a raster layer.

Product Availability

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

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.

setNoDataColor

void setNoDataColor(IColor ppColor)
                    throws IOException,
                           AutomationException

Nodata color for a raster layer.

Product Availability

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

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.

isCreateTiledTIFF

boolean isCreateTiledTIFF()
                          throws IOException,
                                 AutomationException

Indicates if newly created TIFF images should be tiled.

Product Availability

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

Returns:

The pTiled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCreateTiledTIFF

void setCreateTiledTIFF(boolean pTiled)
                        throws IOException,
                               AutomationException

Indicates if newly created TIFF images should be tiled.

Product Availability

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

Parameters:

pTiled - The pTiled (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.