com.esri.arcgis.display
Interface IDotDensityFillSymbol

All Superinterfaces:
IFillSymbol, Serializable
All Known Subinterfaces:
IDotDensityFillSymbol2
All Known Implementing Classes:
DotDensityFillSymbol

public interface IDotDensityFillSymbol
extends IFillSymbol, Serializable

Provides access to the main properties of a data driven symbol commonly used with a dot density renderer.

Superseded By

IDotDensityFillSymbol2

Description

Interface for working with some properties of a DotDensityFillSymbol. Use ISymbolArray to work with the constituent marker symbol(s).

Remarks

IDotDensityFillSymbol controls the appearance of the marker symbols within the dot density fill.

BackgroundColor reflects the color used to fill areas that are not covered by dots--use a NullColor if you wish the underlying layers to be visible through the dots.

Color indicates the color of the dots, and Outline can be used to alter the appearance of the boundary of the shape.

Set FixedPlacement to True if you wish the dots to be alwasy placed in the same location. The DotSize property indicates the size of each dot in points--using a small size, such as 1 to 3 points, is usually most suitable.

The DotCount property contains a zero-based array of values that determine the number of dots drawn in a filled shape.

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, IDotDensityMasking, IDotDensityFillSymbol2, IPictureFillSymbol

Method Summary
 IColor getBackgroundColor()
          The background color.
 int getDotCount(int index)
          The number of dots used to fill.
 double getDotSize()
          The size of dots used to fill.
 double getDotSpacing()
          The distance between dot centers, expressed as a percentage of dot size.
 boolean isFixedPlacement()
          Indicates if the dots are always placed at the same location (the alternative is random placement).
 void setBackgroundColor(IColor color)
          The background color.
 void setDotCount(int index, int dotCount)
          The number of dots used to fill.
 void setDotSize(double dotSize)
          The size of dots used to fill.
 void setDotSpacing(double dotSpacing)
          The distance between dot centers, expressed as a percentage of dot size.
 void setFixedPlacement(boolean fixedPlacement)
          Indicates if the dots are always placed at the same location (the alternative is random placement).
 
Methods inherited from interface com.esri.arcgis.display.IFillSymbol
getColor, getOutline, setColor, setOutline
 

Method Detail

getDotSize

double getDotSize()
                  throws IOException,
                         AutomationException
The size of dots used to fill.

Description

The size of the dots used for filling symbols. Decrease the DotSize for a less dense map, or increase for a more dense map. This value overrides the size values of all of the dot symbols set through ISymbolArray.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDotSize

void setDotSize(double dotSize)
                throws IOException,
                       AutomationException
The size of dots used to fill.

Description

The size of the dots used for filling symbols. Decrease the DotSize for a less dense map, or increase for a more dense map. This value overrides the size values of all of the dot symbols set through ISymbolArray .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getDotCount

int getDotCount(int index)
                throws IOException,
                       AutomationException
The number of dots used to fill.

Product Availability

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

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

setDotCount

void setDotCount(int index,
                 int dotCount)
                 throws IOException,
                        AutomationException
The number of dots used to fill.

Product Availability

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

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

getDotSpacing

double getDotSpacing()
                     throws IOException,
                            AutomationException
The distance between dot centers, expressed as a percentage of dot size.

Description

DotSpacing is expressed as a percentage of dot size, where 100% means that dots can just touch and 0% means that dots can completely overlap. The default is 0%.

You can set a DotSpacing of greater than 100% to enforce a gap between dots.

Remarks

set_DotSpacing is currently not implemented .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDotSpacing

void setDotSpacing(double dotSpacing)
                   throws IOException,
                          AutomationException
The distance between dot centers, expressed as a percentage of dot size.

Description

DotSpacing is expressed as a percentage of dot size, where 100% means that dots can just touch and 0% means that dots can completely overlap. Default is 0%.

You can set a DotSpacing of greater than 100% to enforce a gap between dots.

Remarks

set_DotSpacing is currently not implemented.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isFixedPlacement

boolean isFixedPlacement()
                         throws IOException,
                                AutomationException
Indicates if the dots are always placed at the same location (the alternative is random placement).

Description

Specifies whether or not dots will be drawn at their same positions upon successive redraws. If True, then the dots will be fixed in place on successive redraws. If False, then dots will be placed randomly.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setFixedPlacement

void setFixedPlacement(boolean fixedPlacement)
                       throws IOException,
                              AutomationException
Indicates if the dots are always placed at the same location (the alternative is random placement).

Description

Use this property to control whether dots are placed randomly upon successive redraws, or whether their location is fixed. If True, then dot location is fixed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getBackgroundColor

IColor getBackgroundColor()
                          throws IOException,
                                 AutomationException
The background color.

Description

The color drawn behind the dots. A DotDensityFillSymbol has no true background fill 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.display.IColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackgroundColor

void setBackgroundColor(IColor color)
                        throws IOException,
                               AutomationException
The background color.

Description

The color drawn behind the dots. A DotDensityFillSymbol has no true background fill symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
color - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.