com.esri.arcgis.carto
Interface ITinColorRampRenderer

All Superinterfaces:
Serializable
All Known Implementing Classes:
TinAspectRenderer, TinElevationRenderer, TinNodeElevationRenderer, TinSlopeRenderer

public interface ITinColorRampRenderer
extends Serializable

Provides access to members that draw TIN features based on a continuous attribute like elevation, slope, or aspect.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 double getBreak(int index)
          The value of the break at the index.
 int getBreakCount()
          The number of breaks.
 String getDescription(int index)
          The description for the renderer.
 String getLabel(int index)
          The label for the break at the given index.
 double getMinimumBreak()
          The value of the minimum break.
 ISymbol getSymbol(int index)
          The symbol representing the break at the index.
 boolean isSortClassesAscending()
          Indicates if the sort direction for the legendClass labels is ascending.
 void setBreak(int index, double value)
          The value of the break at the index.
 void setBreakCount(int valueCount)
          The number of breaks.
 void setDescription(int index, String text)
          The description for the renderer.
 void setLabel(int index, String label)
          The label for the break at the given index.
 void setMinimumBreak(double value)
          The value of the minimum break.
 void setSortClassesAscending(boolean ascending)
          Indicates if the sort direction for the legendClass labels is ascending.
 void setSymbol(int index, ISymbol sym)
          The symbol representing the break at the index.
 

Method Detail

getBreakCount

int getBreakCount()
                  throws IOException,
                         AutomationException
The number of breaks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setBreakCount

void setBreakCount(int valueCount)
                   throws IOException,
                          AutomationException
The number of breaks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getSymbol

ISymbol getSymbol(int index)
                  throws IOException,
                         AutomationException
The symbol representing the break at the index.

Product Availability

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

Parameters:
index - The index (in)
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.

setSymbol

void setSymbol(int index,
               ISymbol sym)
               throws IOException,
                      AutomationException
The symbol representing the break at the index.

Product Availability

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

Parameters:
index - The index (in)
sym - 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.

getLabel

String getLabel(int index)
                throws IOException,
                       AutomationException
The label for the break at the given index.

Product Availability

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

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

setLabel

void setLabel(int index,
              String label)
              throws IOException,
                     AutomationException
The label for the break at the given index.

Product Availability

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

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

getDescription

String getDescription(int index)
                      throws IOException,
                             AutomationException
The description for the renderer.

Product Availability

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

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

setDescription

void setDescription(int index,
                    String text)
                    throws IOException,
                           AutomationException
The description for the renderer.

Product Availability

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

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

getBreak

double getBreak(int index)
                throws IOException,
                       AutomationException
The value of the break at the index.

Product Availability

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

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

setBreak

void setBreak(int index,
              double value)
              throws IOException,
                     AutomationException
The value of the break at the index.

Product Availability

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

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

getMinimumBreak

double getMinimumBreak()
                       throws IOException,
                              AutomationException
The value of the minimum break.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setMinimumBreak

void setMinimumBreak(double value)
                     throws IOException,
                            AutomationException
The value of the minimum break.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isSortClassesAscending

boolean isSortClassesAscending()
                               throws IOException,
                                      AutomationException
Indicates if the sort direction for the legendClass labels is ascending.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setSortClassesAscending

void setSortClassesAscending(boolean ascending)
                             throws IOException,
                                    AutomationException
Indicates if the sort direction for the legendClass labels is ascending.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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