com.esri.arcgis.carto
Interface IDotDensityRenderer

All Superinterfaces:
Serializable
All Known Implementing Classes:
DotDensityRenderer

public interface IDotDensityRenderer
extends Serializable

Provides access to members that control the drawing of varying densities of dots within polygon features to represent different quantities.

Description

Use this interface to work with the properties and methods of a DotDensityRenderer . This type of renderer draws randomly placed dots inside polygon features to represent quantitative data. Use to create dot density maps (a.k.a. dot density maps).

Remarks

The DotDensityRenderer uses its DotDensitySymbol to place marker symbols randomly throughout polygon features. The number of markers placed in each polygon depends on DotValue and also the data value for the dot density field(s) specified via IRendererFields.

Though multiple fields can be mapped with a single DotDensityRenderer, typically only one field is used since a map based on multiple fields can be hard to understand.

The renderer supports a way to restrict where dots are placed within polygon features. To do this specify a polygon control layer (also known as a masking layer) via ControlLayer. An overlay is performed between the renderered layer and the ControlLayer, and you specify whether or not dots will only be placed within polygons of the ControlLayer, or only placed outside polygons of the control. Use IDotDensityMasking to set this property.

If you are building a dot density renderer via code, use IDotDensityUIRenderer to set properties of the renderer to make the user interface density previews and sliders work correctly for your renderer and data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void createLegend()
          Creates the legend.
 String getColorScheme()
          Color scheme, (user interface property only).
 IFeatureLayer getControlLayer()
          Control layer used for masking.
 IDotDensityFillSymbol getDotDensitySymbol()
          The dot density symbol.
 double getDotValue()
          Value of each dot.
 boolean isMaintainSize()
          Indicates if dot size is preserved when zooming (the alternative is that density is preserved).
 void setColorScheme(String name)
          Color scheme, (user interface property only).
 void setControlLayerByRef(IFeatureLayer layer)
          Control layer used for masking.
 void setDotDensitySymbolByRef(IDotDensityFillSymbol symbol)
          The dot density symbol.
 void setDotValue(double value)
          Value of each dot.
 void setMaintainSize(boolean flag)
          Indicates if dot size is preserved when zooming (the alternative is that density is preserved).
 

Method Detail

getDotDensitySymbol

IDotDensityFillSymbol getDotDensitySymbol()
                                          throws IOException,
                                                 AutomationException
The dot density 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.IDotDensityFillSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDotDensitySymbolByRef

void setDotDensitySymbolByRef(IDotDensityFillSymbol symbol)
                              throws IOException,
                                     AutomationException
The dot density symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getDotValue

double getDotValue()
                   throws IOException,
                          AutomationException
Value of each dot.

Description

This property controls how many dots will be placed in each polygon. As DotValue increases, fewer dots will be placed in each polygon. Conversely, use a smaller DotValue to place more dots in each polygon. Customarily, a round number is used for this value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDotValue

void setDotValue(double value)
                 throws IOException,
                        AutomationException
Value of each dot.

Description

The DotValue controls how many dots will be placed in each polygon. As the value increases, fewer dots will be placed in each polygon. Conversely, use a smaller DotValue to place more dots in each polygon. Customarily, a round number is used for this value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getControlLayer

IFeatureLayer getControlLayer()
                              throws IOException,
                                     AutomationException
Control layer used for masking.

Description

This is the layer used for dot density masking. Dot density masking restricts the placement of dots within the polygons being renderered based on the polygons in the ControlLayer. Use IDotDensityMasking to access additional masking properties.

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

setControlLayerByRef

void setControlLayerByRef(IFeatureLayer layer)
                          throws IOException,
                                 AutomationException
Control layer used for masking.

Description

The ControlLayer is the layer used for masking. Masking restricts the placement of dots within specified areas of the ControlLayer. Use IDotDensityMasking to access additional masking properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getColorScheme

String getColorScheme()
                      throws IOException,
                             AutomationException
Color scheme, (user interface property only).

Description

The name of the color scheme for the renderer. This string is used by the MultiDotDensityPropertyPage.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setColorScheme

void setColorScheme(String name)
                    throws IOException,
                           AutomationException
Color scheme, (user interface property only).

Description

The name of the color scheme for the renderer. This string is used by the MultiDotDensityPropertyPage .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

createLegend

void createLegend()
                  throws IOException,
                         AutomationException
Creates the legend. Call after all properties are set.

Description

Call this method after making any changes to the dot density renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setMaintainSize

void setMaintainSize(boolean flag)
                     throws IOException,
                            AutomationException
Indicates if dot size is preserved when zooming (the alternative is that density is preserved).

Description

Controls whether dot density or dot size is held constant when the map scale changes. If True, then dot size is maintained.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isMaintainSize

boolean isMaintainSize()
                       throws IOException,
                              AutomationException
Indicates if dot size is preserved when zooming (the alternative is that density is preserved).

Description

Specifies whether or not dot size is held constant when the map scale changes. If True, then dot size is maintained.

If False, then dot density is held constant and dot size will change. What this means is that when you zoom in on the map, the size of dots will increase to maintain the same density of "inked" space in each polygon. When you zoom out, the size of dots will decrease, again to maintain the same density of "inked" space in each feature between the old and new scale.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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