com.esri.arcgis.carto
Interface IRasterStretchColorRampRenderer

All Superinterfaces:
Serializable
All Known Implementing Classes:
RasterStretchColorRampRenderer

public interface IRasterStretchColorRampRenderer
extends Serializable

Provides access to members that control the color ramp of a contrast stretch.

When To Use

The IRasterStretchColorRampRenderer interface controls the display of a raster dataset stretched along a color ramp. It is usually used for visualizing continuous raster data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 int getBandIndex()
          Index of the band to be rendered.
 IColorRamp getColorRamp()
          Color ramp.
 String getColorScheme()
          ColorScheme name.
 String getLabelHigh()
          Label for highest value.
 String getLabelLow()
          Label for lowest value.
 String getLabelMedium()
          Label for medium value.
 void resetLabels()
          Makes default labels.
 void setBandIndex(int bandIndex)
          Index of the band to be rendered.
 void setColorRamp(IColorRamp ppColorRamp)
          Color ramp.
 void setColorScheme(String colorScheme)
          ColorScheme name.
 void setLabelHigh(String label)
          Label for highest value.
 void setLabelLow(String label)
          Label for lowest value.
 void setLabelMedium(String label)
          Label for medium value.
 

Method Detail

setBandIndex

void setBandIndex(int bandIndex)
                  throws IOException,
                         AutomationException
Index of the band to be rendered.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
bandIndex - The bandIndex (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBandIndex

int getBandIndex()
                 throws IOException,
                        AutomationException
Index of the band to be rendered.

Remarks

The BandIndex property specifies the band in the raster dataset to be drawn. For single-band data, this should be 0, but with multiband data any band may be selected.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The bandIndex
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColorScheme

String getColorScheme()
                      throws IOException,
                             AutomationException
ColorScheme name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The colorScheme
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setColorScheme

void setColorScheme(String colorScheme)
                    throws IOException,
                           AutomationException
ColorScheme name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
colorScheme - The colorScheme (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColorRamp

IColorRamp getColorRamp()
                        throws IOException,
                               AutomationException
Color ramp.

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.IColorRamp
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setColorRamp

void setColorRamp(IColorRamp ppColorRamp)
                  throws IOException,
                         AutomationException
Color ramp.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
ppColorRamp - A reference to a com.esri.arcgis.display.IColorRamp (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelLow

String getLabelLow()
                   throws IOException,
                          AutomationException
Label for lowest value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The label
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelLow

void setLabelLow(String label)
                 throws IOException,
                        AutomationException
Label for lowest value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
label - The label (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelMedium

String getLabelMedium()
                      throws IOException,
                             AutomationException
Label for medium value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The label
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelMedium

void setLabelMedium(String label)
                    throws IOException,
                           AutomationException
Label for medium value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
label - The label (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelHigh

String getLabelHigh()
                    throws IOException,
                           AutomationException
Label for highest value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The label
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelHigh

void setLabelHigh(String label)
                  throws IOException,
                         AutomationException
Label for highest value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
label - The label (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

resetLabels

void resetLabels()
                 throws IOException,
                        AutomationException
Makes default labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.