com.esri.arcgis.carto
Interface ITinContourRenderer

All Superinterfaces:
Serializable
All Known Implementing Classes:
TinContourRenderer

public interface ITinContourRenderer
extends Serializable

Provides access to members that control contour rendering.

Product Availability

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


Method Summary
 String getContourDescription()
          The description for the label.
 double getContourInterval()
          The contour interval.
 String getContourLabel()
          The descriptive symbol text.
 ISymbol getContourSymbol()
          The symbol used to render the contour.
 String getIndexContourDescription()
          The description for the index contour.
 int getIndexContourFactor()
          The index contour factor.
 String getIndexContourLabel()
          The label for the index contour.
 ISymbol getIndexContourSymbol()
          The symbol used to render index contour.
 double getReferenceContourHeight()
          The reference contour height.
 void setContourDescription(String text)
          The description for the label.
 void setContourInterval(double interval)
          The contour interval.
 void setContourLabel(String label)
          The descriptive symbol text.
 void setContourSymbolByRef(ISymbol symbol)
          The symbol used to render the contour.
 void setIndexContourDescription(String text)
          The description for the index contour.
 void setIndexContourFactor(int factor)
          The index contour factor.
 void setIndexContourLabel(String label)
          The label for the index contour.
 void setIndexContourSymbolByRef(ISymbol symbol)
          The symbol used to render index contour.
 void setReferenceContourHeight(double height)
          The reference contour height.
 

Method Detail

getReferenceContourHeight

double getReferenceContourHeight()
                                 throws IOException,
                                        AutomationException
The reference contour height.

Product Availability

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

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

setReferenceContourHeight

void setReferenceContourHeight(double height)
                               throws IOException,
                                      AutomationException
The reference contour height.

Product Availability

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

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

getContourInterval

double getContourInterval()
                          throws IOException,
                                 AutomationException
The contour interval.

Product Availability

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

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

setContourInterval

void setContourInterval(double interval)
                        throws IOException,
                               AutomationException
The contour interval.

Product Availability

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

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

getIndexContourFactor

int getIndexContourFactor()
                          throws IOException,
                                 AutomationException
The index contour factor.

Product Availability

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

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

setIndexContourFactor

void setIndexContourFactor(int factor)
                           throws IOException,
                                  AutomationException
The index contour factor.

Product Availability

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

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

getContourSymbol

ISymbol getContourSymbol()
                         throws IOException,
                                AutomationException
The symbol used to render the contour.

Product Availability

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

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.

setContourSymbolByRef

void setContourSymbolByRef(ISymbol symbol)
                           throws IOException,
                                  AutomationException
The symbol used to render the contour.

Product Availability

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

Parameters:
symbol - 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.

getContourLabel

String getContourLabel()
                       throws IOException,
                              AutomationException
The descriptive symbol text.

Product Availability

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

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

setContourLabel

void setContourLabel(String label)
                     throws IOException,
                            AutomationException
The descriptive symbol text.

Product Availability

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

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

getContourDescription

String getContourDescription()
                             throws IOException,
                                    AutomationException
The description for the label.

Product Availability

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

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

setContourDescription

void setContourDescription(String text)
                           throws IOException,
                                  AutomationException
The description for the label.

Product Availability

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

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

getIndexContourSymbol

ISymbol getIndexContourSymbol()
                              throws IOException,
                                     AutomationException
The symbol used to render index contour.

Product Availability

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

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.

setIndexContourSymbolByRef

void setIndexContourSymbolByRef(ISymbol symbol)
                                throws IOException,
                                       AutomationException
The symbol used to render index contour.

Product Availability

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

Parameters:
symbol - 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.

getIndexContourLabel

String getIndexContourLabel()
                            throws IOException,
                                   AutomationException
The label for the index contour.

Product Availability

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

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

setIndexContourLabel

void setIndexContourLabel(String label)
                          throws IOException,
                                 AutomationException
The label for the index contour.

Product Availability

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

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

getIndexContourDescription

String getIndexContourDescription()
                                  throws IOException,
                                         AutomationException
The description for the index contour.

Product Availability

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

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

setIndexContourDescription

void setIndexContourDescription(String text)
                                throws IOException,
                                       AutomationException
The description for the index contour.

Product Availability

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

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