com.esri.arcgis.display
Interface IMultiPartColorRamp

All Superinterfaces:
IColorRamp, Serializable
All Known Implementing Classes:
MultiPartColorRamp

public interface IMultiPartColorRamp
extends IColorRamp, Serializable

Provides access to members that control the MultiPartColorRamp. A color ramp defined by a list of constituent color ramps.

Description

IMultiPartColorRamp provides the framework for concatenating color ramps. After creating a MultiPartColorRamp object, you can add color ramps to it with the AddRamp method. You can add existing algorithmic, preset, random, or even other multipart color ramps.
A MultiPartColorRamp will try to use an equal number of colors from each member ramp to create its colors. You can check the number of ramps in a MultiPartColorRamp by reading the NumberOfRamps property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
IPresetColorRamp, IMultiPartColorRamp, IAlgorithmicColorRamp, IColorRamp.getColor(int), IRandomColorRamp, IColorRamp.createRamp(boolean[]), IColorRamp

Method Summary
 void addRamp(IColorRamp colorRamp)
          Adds a color ramp to the list.
 int getNumberOfRamps()
          The number of constituent color ramps.
 IColorRamp getRamp(int index)
          The color ramp at the index position.
 void removeRamp(int index)
          Removes the color ramp located at the index position.
 void setRamp(int index, IColorRamp colorRamp)
          The color ramp at the index position.
 
Methods inherited from interface com.esri.arcgis.display.IColorRamp
createRamp, getColor, getColors, getName, getSize, setName, setSize
 

Method Detail

setRamp

void setRamp(int index,
             IColorRamp colorRamp)
             throws IOException,
                    AutomationException
The color ramp at the index position.

Product Availability

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

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

getRamp

IColorRamp getRamp(int index)
                   throws IOException,
                          AutomationException
The color ramp at the index position.

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

addRamp

void addRamp(IColorRamp colorRamp)
             throws IOException,
                    AutomationException
Adds a color ramp to the list.

Description

AddRamp is how color ramps are added to an IMultiPartColorRamp .

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.

removeRamp

void removeRamp(int index)
                throws IOException,
                       AutomationException
Removes the color ramp located at the index position.

Description

RemoveRamp removes the specified ramp from an IMultiPartColorRamp .

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.

getNumberOfRamps

int getNumberOfRamps()
                     throws IOException,
                            AutomationException
The number of constituent color ramps.

Description

NumberOfRamps is the number of ramps that have been added to an IMultiPartColorRamp .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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