com.esri.arcgis.carto
Interface IColorRampSymbol

All Superinterfaces:

IFillSymbol, Serializable

All Known Subinterfaces:

IColorRampSymbol2

All Known Implementing Classes:

ColorRampSymbol, IColorRampSymbol2Proxy, IColorRampSymbolProxy

public interface IColorRampSymbol
extends IFillSymbol, Serializable

Provides access to members that control ColorRamp symbolization.

Product Availability

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

Method Summary

IColorRamp	getColorRamp() Current color ramp.
int	getLegendClassIndex() Ordinal number of the legend class for the symbol (0,1,2).
ILegendGroup	getLegendGroup() Legend group of the symbol.
boolean	isInvert() Indicates whether to invert.
void	setColorRamp(IColorRamp colorRamp) Current color ramp.
void	setColorRampInLegendGroup(IColorRamp rhs1) Not documented.
void	setInvert(boolean invert) Indicates whether to invert.
void	setLegendClassIndex(int index) Ordinal number of the legend class for the symbol (0,1,2).
void	setLegendGroupByRef(ILegendGroup ppLegendGroup) Legend group of the symbol.

Methods inherited from interface com.esri.arcgis.display.IFillSymbol

getColor, getOutline, setColor, setOutline

Method Detail

getColorRamp

IColorRamp getColorRamp()
                        throws IOException,
                               AutomationException

Current 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 colorRamp)
                  throws IOException,
                         AutomationException

Current color ramp.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

setColorRampInLegendGroup

void setColorRampInLegendGroup(IColorRamp rhs1)
                               throws IOException,
                                      AutomationException

Not documented.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

isInvert

boolean isInvert()
                 throws IOException,
                        AutomationException

Indicates whether to invert.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The invert

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInvert

void setInvert(boolean invert)
               throws IOException,
                      AutomationException

Indicates whether to invert.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

invert - The invert (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendClassIndex

int getLegendClassIndex()
                        throws IOException,
                               AutomationException

Ordinal number of the legend class for the symbol (0,1,2).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLegendClassIndex

void setLegendClassIndex(int index)
                         throws IOException,
                                AutomationException

Ordinal number of the legend class for the symbol (0,1,2).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendGroup

ILegendGroup getLegendGroup()
                            throws IOException,
                                   AutomationException

Legend group of the symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLegendGroupByRef

void setLegendGroupByRef(ILegendGroup ppLegendGroup)
                         throws IOException,
                                AutomationException

Legend group of the symbol.

Product Availability

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

Parameters:

ppLegendGroup - A reference to a com.esri.arcgis.carto.ILegendGroup (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.