com.esri.arcgis.carto
Interface IRasterCatalogRendererPicker

All Superinterfaces:

Serializable

All Known Implementing Classes:

RasterCatalogRendererPickerDefault

public interface IRasterCatalogRendererPicker
extends Serializable

Provides access to methods that choose appropriate raster renderers for a RasterCatalog.

Description

The IRasterCatalogRendererPicker interface controls the raster renderer picking rules used to control the default display of a geodatabase raster catalog layer.

The AllAvailableRenderersCLSID property returns an array of ProgIDs of all the available renderers that are associated with the raster catalog layer. An example of ProgID is “esriCarto.RasterRGBRenderer” for the RasterRGBRenderer object.

The DefaultUseRenderersCLSID , a read only property, returns an array of ProgIDs of the raster renderers that are used in rendering the raster catalog layer.

The Pick method sets the rules for rendering raster datasets in a raster catalog. This is where you can apply your own rendering rules. Based on the property of the input raster dataset, you need to return a renderer from the available renderers.

The Priority property returns the priority of this raster catalog renderer picker relative to others in the system. The priority of the system default RasterCatalogRendererPickerDefault object is 0.

To create a custom raster catalog renderer picker object; implement this interface, assign a higher number to the Priority, then register this object with RasterCatalogRendererPickers component category.

The raster catalog renderer picker objects registered in the system are called with decreasing priority until a valid picker is found. For raster datasets in the raster catalog that you wish to use the system default picker, return Null instead of a valid renderer. If no renderer is returned from this raster catalog renderer picker, the raster dataset will be passed to the next highest priority renderer picker object until a renderer is found.

Product Availability

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

Method Summary

String[]	getAllAvailableRenderersCLSID() The ProgIDs of all available raster renderers.
String[]	getDefaultUseRenderersCLSID() The ProgIDs of the default raster renderers.
int	getPriority() The priority of the renderer.
IRasterRenderer	pick(IArray pRenderers, IRasterDataset pRasterDataset) Chooses the renderers from a given list.

Method Detail

getPriority

int getPriority()
                throws IOException,
                       AutomationException

The priority of the renderer.

Remarks

The Priority property returns the priority of this raster catalog renderer picker relative to others in the system. The priority of the system default RasterCatalogRendererPickerDefault object is 0. You need to return a bigger number when you create your custom renderer picker.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pPriority

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultUseRenderersCLSID

String[] getDefaultUseRenderersCLSID()
                                     throws IOException,
                                            AutomationException

The ProgIDs of the default raster renderers.

Remarks

The DefaultUseRenderersCLSID, a read only property, returns an array of ProgIDs of the raster renderers that are used in rendering the raster catalog layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pCLSIDArrayy

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllAvailableRenderersCLSID

String[] getAllAvailableRenderersCLSID()
                                       throws IOException,
                                              AutomationException

The ProgIDs of all available raster renderers.

Remarks

The AllAvailableRenderersCLSID property returns an array of ProgIDs of all the available renderers that are associated with the raster catalog layer. An example of ProgID is “esriCarto.RasterRGBRenderer” for the RasterRGBRenderer object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pCLSIDArrayy

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

pick

IRasterRenderer pick(IArray pRenderers,
                     IRasterDataset pRasterDataset)
                     throws IOException,
                            AutomationException

Chooses the renderers from a given list.

Remarks

The Pick method sets the rules for rendering raster datasets in a raster catalog. This is where you can apply your own rendering rules. Based on the property of the input raster dataset, you need to return a renderer from the available renderers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pRenderers - A reference to a com.esri.arcgis.system.IArray (in)

pRasterDataset - A reference to a com.esri.arcgis.geodatabase.IRasterDataset (in)

Returns:

A reference to a com.esri.arcgis.carto.IRasterRenderer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.