com.esri.arcgis.display
Interface IRandomColorRamp

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

public interface IRandomColorRamp
extends IColorRamp, Serializable

Provides access to members that control the properties of a RandomColorRamp. A color ramp that is a list of randomly picked colors.

Description

IRandomColorRamp generates a specified number of unique, equally different, colors. The range of colors can be restricted based on a hue range, value range, or saturation range. The RandomColorRamp is designed around the HSV color model and therefore the colors in a random color ramp may be restricted in terms of hue, saturation, and value. Setting the StartHue and EndHue properties to values between 0 and 360 will restrict the colors that may appear in the ramp. Setting MinValue and MaxValue to between 0 and 100 will restrict the brightness, and setting MinSaturation and MaxSaturation to between 0 and 100 will restrict the purity of the colors in the ramp. Remember when you are setting your ranges that StartHue must alwasy be less than the EndHue, MinSaturation less than MaxSaturation, and MinValue less than MaxValue. If the values are set incorrectly, the RandomColorRamp will use the full range of hue, saturation, or value.

By default, the UseSeed property of the IRandomColorRamp is False. In this case, the RandomColorRamp creates a new random number to use as the seed value for each call to CreateRamp, ensuring that the Colors created are random and different each time CreateRamp is called. If the UseSeed property is set to True, the seed used for the RandomColorRamp is taken from the Seed property, and therefore each time you call CreateRamp with a specific Seed value, the sequence of colors created is unchanged.


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
 int getEndHue()
          The end hue (0-360).
 int getMaxSaturation()
          The maximum saturation (0-100).
 int getMaxValue()
          The maximum value (0-100).
 int getMinSaturation()
          The minimum saturation (0-100).
 int getMinValue()
          The minimum value (0-100).
 int getSeed()
          The seed of the random number generator.
 int getStartHue()
          The start hue (0-360).
 boolean isUseSeed()
          Indicates if a seed is used when the ramp is generated.
 void setEndHue(int endHue)
          The end hue (0-360).
 void setMaxSaturation(int maxSaturation)
          The maximum saturation (0-100).
 void setMaxValue(int maxValue)
          The maximum value (0-100).
 void setMinSaturation(int minSaturation)
          The minimum saturation (0-100).
 void setMinValue(int minValue)
          The minimum value (0-100).
 void setSeed(int seed)
          The seed of the random number generator.
 void setStartHue(int startHue)
          The start hue (0-360).
 void setUseSeed(boolean useSeed)
          Indicates if a seed is used when the ramp is generated.
 
Methods inherited from interface com.esri.arcgis.display.IColorRamp
createRamp, getColor, getColors, getName, getSize, setName, setSize
 

Method Detail

setSeed

void setSeed(int seed)
             throws IOException,
                    AutomationException
The seed of the random number generator.

Description

Seed is any number that is different than the one you might have just used with a specific IRandomColorRamp .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getSeed

int getSeed()
            throws IOException,
                   AutomationException
The seed of the random number generator.

Description

Seed is any number that is different than the one you might have just used with a specific IRandomColorRamp.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setUseSeed

void setUseSeed(boolean useSeed)
                throws IOException,
                       AutomationException
Indicates if a seed is used when the ramp is generated. Set this property to True without changing the Seed to generate identical color ramps in succession.

Description

UseSeed is whether or not the IRandomColorRamp will use a random seed. If not, then the same sequence of random colors will be generated each time a specific color ramp is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isUseSeed

boolean isUseSeed()
                  throws IOException,
                         AutomationException
Indicates if a seed is used when the ramp is generated. Set this property to True without changing the Seed to generate identical color ramps in succession.

Description

UseSeed is whether or not the IRandomColorRamp will use a random seed. If not, then the same sequence of random colors will be generated each time a specific color ramp is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setMinValue

void setMinValue(int minValue)
                 throws IOException,
                        AutomationException
The minimum value (0-100).

Description

MinValue is minimum value any random color can be (0-100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getMinValue

int getMinValue()
                throws IOException,
                       AutomationException
The minimum value (0-100).

Description

MinValue is minimum value any random color can be (0-100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setMaxValue

void setMaxValue(int maxValue)
                 throws IOException,
                        AutomationException
The maximum value (0-100).

Description

MaxValue is maximum value any random color can be (0-100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getMaxValue

int getMaxValue()
                throws IOException,
                       AutomationException
The maximum value (0-100).

Description

MaxValue is maximum value any random color can be (0-100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setMinSaturation

void setMinSaturation(int minSaturation)
                      throws IOException,
                             AutomationException
The minimum saturation (0-100).

Description

MinSaturation is minimum saturation any random color can be (0-100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getMinSaturation

int getMinSaturation()
                     throws IOException,
                            AutomationException
The minimum saturation (0-100).

Description

MinSaturation is minimum saturation any random color can be (0-100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setMaxSaturation

void setMaxSaturation(int maxSaturation)
                      throws IOException,
                             AutomationException
The maximum saturation (0-100).

Description

MaxSaturation is maximum saturation any random color can be (0-100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getMaxSaturation

int getMaxSaturation()
                     throws IOException,
                            AutomationException
The maximum saturation (0-100).

Description

MaxSaturation is maximum saturation any random color can be (0-100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setStartHue

void setStartHue(int startHue)
                 throws IOException,
                        AutomationException
The start hue (0-360).

Description

StartHue is minimum hue any random color can be (0-360).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
startHue - The startHue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IHsvColor, IHlsColor

getStartHue

int getStartHue()
                throws IOException,
                       AutomationException
The start hue (0-360).

Description

StartHue is minimum hue any random color can be (0-360).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The startHue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IHsvColor, IHlsColor

setEndHue

void setEndHue(int endHue)
               throws IOException,
                      AutomationException
The end hue (0-360).

Description

EndHue is maximum hue any random color can be (0-360).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
endHue - The endHue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IHsvColor, IHlsColor

getEndHue

int getEndHue()
              throws IOException,
                     AutomationException
The end hue (0-360).

Description

EndHue is maximum hue any random color can be (0-360).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The endHue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IHsvColor, IHlsColor