com.esri.arcgis.carto
Interface IRasterCatalogDisplayProps

All Superinterfaces:

Serializable

All Known Subinterfaces:

IRasterCatalogDisplayProps2

All Known Implementing Classes:

GdbRasterCatalogLayer, RasterCatalogLayer

public interface IRasterCatalogDisplayProps
extends Serializable

Provides access to members that create or modify a raster catalog.

Product Availability

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

Method Summary

int	getDelayDraw() The time in millisecond to delay the drawing of each raster.
int	getDisplayRasters() Indicates whether to display rasters.
int	getResamplingType() Resampling method for displaying a raster.
ISymbol	getSymbol() The symbol of the layer.
double	getTransitionScale() The scale value to transition between wireframe and raster display.
boolean	isDrawRastersOnly() Indicates whether to draw the rasters only.
boolean	isRedrawDisplay() Indicates whether the display should redraw the layer.
boolean	isUseScale() Indicates whether the scale is use to control wireframe/raster display transition.
void	setDelayDraw(int ms) The time in millisecond to delay the drawing of each raster.
void	setDisplayRasters(int pNum) Indicates whether to display rasters.
void	setDrawRastersOnly(boolean b) Indicates whether to draw the rasters only.
void	setRedrawDisplay(boolean b) Indicates whether the display should redraw the layer.
void	setResamplingType(int pResamplingType) Resampling method for displaying a raster.
void	setSymbolByRef(ISymbol ppSymbol) The symbol of the layer.
void	setTransitionScale(double scale) The scale value to transition between wireframe and raster display.
void	setUseScale(boolean b) Indicates whether the scale is use to control wireframe/raster display transition.

Method Detail

getDisplayRasters

int getDisplayRasters()
                      throws IOException,
                             AutomationException

Indicates whether to display rasters.

Remarks

The DisplayRasters property specifies a threshold (the number of raster datasets are within the display extent) that controls the raster catalog display mode. If the number of the raster datasets in the display extent is greater than the threshold, the raster catalog displays as a wireframe. Otherwise the raster datasets within the display extent will be drawn. The default threshold is 9.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pNum

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayRasters

void setDisplayRasters(int pNum)
                       throws IOException,
                              AutomationException

Indicates whether to display rasters.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pNum - The pNum (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSymbol

ISymbol getSymbol()
                  throws IOException,
                         AutomationException

The symbol of the layer.

Remarks

The Symbol specifies the symbol to be use in rendering a raster catalog’s wire frames.

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.ISymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSymbolByRef

void setSymbolByRef(ISymbol ppSymbol)
                    throws IOException,
                           AutomationException

The symbol of the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

ppSymbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseScale

void setUseScale(boolean b)
                 throws IOException,
                        AutomationException

Indicates whether the scale is use to control wireframe/raster display transition.

Remarks

The UseScale property is also a threshold (map scale) that switches between the raster catalog display modes. For example, if you want the raster catalog display to be switched when displaying at a map scale 1:50000, you should set 50000 to this property. When the display scale goes bigger (i.e. 1:40000), it displays as raster datasets, and when the display scale goes smaller (i.e. 1:60000), it is displayed as a wireframe. This property has a higher priority than the threshold set by DisplayRasters. The UseScale must be true in order to use the this threshold.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

b - The b (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseScale

boolean isUseScale()
                   throws IOException,
                          AutomationException

Indicates whether the scale is use to control wireframe/raster display transition.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The b

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransitionScale

void setTransitionScale(double scale)
                        throws IOException,
                               AutomationException

The scale value to transition between wireframe and raster display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

scale - The scale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTransitionScale

double getTransitionScale()
                          throws IOException,
                                 AutomationException

The scale value to transition between wireframe and raster display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The scale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRedrawDisplay

boolean isRedrawDisplay()
                        throws IOException,
                               AutomationException

Indicates whether the display should redraw the layer.

Remarks

Setting the RedrawDisplay property to be true will redraw raster datasets in the display each time you pan or zoom; the default is false.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The b

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRedrawDisplay

void setRedrawDisplay(boolean b)
                      throws IOException,
                             AutomationException

Indicates whether the display should redraw the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

b - The b (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDelayDraw

int getDelayDraw()
                 throws IOException,
                        AutomationException

The time in millisecond to delay the drawing of each raster.

Remarks

The DelayDraw property controls the time interval in millisecond between drawing raster datasets. The default is set to 0. If the DelayDraw is set to a value that is less than the time that takes to draw one raster dataset, you will not see the difference by setting this delay property. You might want to increase this delay value to adjust to your application.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The ms

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDelayDraw

void setDelayDraw(int ms)
                  throws IOException,
                         AutomationException

The time in millisecond to delay the drawing of each raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

ms - The ms (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResamplingType

int getResamplingType()
                      throws IOException,
                             AutomationException

Resampling method for displaying a raster.

Remarks

The ResamplingType specifies the resample type used in displaying raster datasets. The default is set to be NearestNeighbor resampling.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.geodatabase.rstResamplingTypes constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResamplingType

void setResamplingType(int pResamplingType)
                       throws IOException,
                              AutomationException

Resampling method for displaying a raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pResamplingType - A com.esri.arcgis.geodatabase.rstResamplingTypes constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDrawRastersOnly

void setDrawRastersOnly(boolean b)
                        throws IOException,
                               AutomationException

Indicates whether to draw the rasters only.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

b - The b (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDrawRastersOnly

boolean isDrawRastersOnly()
                          throws IOException,
                                 AutomationException

Indicates whether to draw the rasters only.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The b

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.