com.esri.arcgis.display
Interface IGradientFillSymbol

All Superinterfaces:
IFillSymbol, Serializable
All Known Implementing Classes:
GradientFillSymbol

public interface IGradientFillSymbol
extends IFillSymbol, Serializable

Provides access to members that control the gradient fill symbol.

Description

IGradientFillSymbol is used to draw color ramp within the limits of the filled area. You can set the GradientPercentage to control the saturation and the IntervalCount to set the number of displayed colors. Additionally, Style and GradientAngle can be set to further control the appearance of the ramp within the fill. Use the IFillSymbol interface to set additional properties for IGradientFillSymbols.

Remarks

Set any IColorRamp onto the ColorRamp property and it will be used to fill the areal feature. A graded effect can best be achieved by using an AlgorithmicColorRamp.

Note that you do not need to set a Size or call CreateRamp on your ColorRamp. Instead, the IntervalCount property defines the number of color steps required. Set the IntervalCount property depending on what kind of effect you wish to achieve.

You may wish to use the GradientFillSymbol to produce a smooth gradation of color in an area and therefore need an appropriate IntervalCount. The average computer screen has a resolution at least three times as coarse as the average printer at 300 dpi, as a rough guide. Therefore, a smooth fill on the screen may appear banded in the printed output.

To produce a smooth progression of color in your fill for output to a pirinter, first set the 1:1 scale on the PageLayout view to account for differences in printed scale and onscreen scale. Next, experiment to find the IntervalCount at which the fill appears smooth on the screen--this will be dependent on the characteristics of your ColorRamp, the size of the area to be filled, and the GradientPercentage. Then, multiply the IntervalCount by at least 3 times and try your output.

The GradientPercentage can be a value between 0 and 1. A value of one indicates that the entire shape should be filled with the color ramp, but a value of 0.5 indicates only half the shape should be filled with the color ramp; the first half of the area is filled by the first color in the color ramp, and the remaining area is filled with the color ramp.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
IFillProperties, IFillSymbol, IDotDensityFillSymbol, IMarkerFillSymbol, ILineFillSymbol, IMultiLayerFillSymbol, IGradientFillSymbol, IDotDensityFillSymbol2, IPictureFillSymbol

Method Summary
 IColorRamp getColorRamp()
          Color ramp property.
 double getGradientAngle()
          Direction of fill gradient.
 double getGradientPercentage()
          Gradient percentage - controls the bleeding effect of the fill.
 int getIntervalCount()
          Interval count - controls number of colors in the color ramp.
 int getStyle()
          Gradient fill style.
 void setColorRamp(IColorRamp ramp)
          Color ramp property.
 void setGradientAngle(double angle)
          Direction of fill gradient.
 void setGradientPercentage(double pct)
          Gradient percentage - controls the bleeding effect of the fill.
 void setIntervalCount(int intervalCount)
          Interval count - controls number of colors in the color ramp.
 void setStyle(int style)
          Gradient fill style.
 
Methods inherited from interface com.esri.arcgis.display.IFillSymbol
getColor, getOutline, setColor, setOutline
 

Method Detail

getStyle

int getStyle()
             throws IOException,
                    AutomationException
Gradient fill style.

Description

Style is the enumeration that defines the shape of the gradient. There are four options: esriGFSBuffered, esriGFSCircular, esriGFSLinear, and esriGFSRectangular. esriGFSLinear is the default Style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.display.esriGradientFillStyle constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStyle

void setStyle(int style)
              throws IOException,
                     AutomationException
Gradient fill style.

Description

Style is the enumeration that defines the shape of the gradient. There are four options: esriGFSBuffered, esriGFSCircular, esriGFSLinear, and esriGFSRectangular. esriGFSLinear is the default Style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
style - A com.esri.arcgis.display.esriGradientFillStyle constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGradientAngle

double getGradientAngle()
                        throws IOException,
                               AutomationException
Direction of fill gradient.

Description

GradientAngle rotates the gradient within the fill. Valid ranges are from -360 to 360. The default angle is 90.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setGradientAngle

void setGradientAngle(double angle)
                      throws IOException,
                             AutomationException
Direction of fill gradient.

Description

GradientAngle rotates the gradient within the fill. Valid ranges are from -360 to 360. The default angle is 90.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getColorRamp

IColorRamp getColorRamp()
                        throws IOException,
                               AutomationException
Color ramp property.

Description

ColorRamp is the ramp used to display as the gradient. Any ramp supported by the IColorRamp object can be used.

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 ramp)
                  throws IOException,
                         AutomationException
Color ramp property.

Description

ColorRamp is the ramp used to display as the gradient. Any ramp supported by the IColorRamp object can be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getGradientPercentage

double getGradientPercentage()
                             throws IOException,
                                    AutomationException
Gradient percentage - controls the bleeding effect of the fill.

Description

GradientPercentage controls the saturation distribution between the colors. Valid values are from 0 to 1. The default value is 0.75.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setGradientPercentage

void setGradientPercentage(double pct)
                           throws IOException,
                                  AutomationException
Gradient percentage - controls the bleeding effect of the fill.

Description

GradientPercentage controls the saturation distribution between the colors. Valid values are from 0 to 1. The default value is 0.75.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getIntervalCount

int getIntervalCount()
                     throws IOException,
                            AutomationException
Interval count - controls number of colors in the color ramp.

Description

IntervalCount determines the number of colors used in the gradient. A minimum value of two is required to display a ramp.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setIntervalCount

void setIntervalCount(int intervalCount)
                      throws IOException,
                             AutomationException
Interval count - controls number of colors in the color ramp.

Description

IntervalCount determines the number of colors used in the gradient. A minimum value of two is required to display a ramp.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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