com.esri.arcgis.carto
Interface IProportionalSymbolRenderer

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
IProportionalSymbolRendererProxy, ProportionalSymbolRenderer

public interface IProportionalSymbolRenderer
extends java.io.Serializable

COM Interface 'IProportionalSymbolRenderer'. Generated 3/19/2015 1:20:52 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that control the drawing of varying size symbols for each feature, each sized in proportion to a field value.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IIDec45bfa6_8efc_11d2_ab21_00c04fa334b3
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void createLegendSymbols()
          Creates the legend.
 IFillSymbol getBackgroundSymbol()
          Background fill symbol used when proportional marker symbols are draw on polygon features.
 java.lang.String getField()
          Value field.
 int getLegendSymbolCount()
          Number of symbols displayed in the TOC and legend.
 ISymbol getMinSymbol()
          Symbol used to draw feature with the normalized minimum data value.
 java.lang.String getNormField()
          Normalization field.
 int getValueRepresentation()
          Representation type of the value field.
 int getValueUnit()
          Units of the value field.
 boolean isFlanneryCompensation()
          Indicates if Flannery Compensation is applied.
 void setBackgroundSymbol(IFillSymbol sym)
          Background fill symbol used when proportional marker symbols are draw on polygon features.
 void setField(java.lang.String field)
          Value field.
 void setFlanneryCompensation(boolean flag)
          Indicates if Flannery Compensation is applied.
 void setLegendSymbolCount(int num)
          Number of symbols displayed in the TOC and legend.
 void setMaxDataValue(double rhs1)
          Normalized maximum data value.
 void setMinDataValue(double rhs1)
          Normalized minimum data value.
 void setMinSymbol(ISymbol sym)
          Symbol used to draw feature with the normalized minimum data value.
 void setNormField(java.lang.String field)
          Normalization field.
 void setValueRepresentation(int rep)
          Representation type of the value field.
 void setValueUnit(int unit)
          Units of the value field.
 

Field Detail

IIDec45bfa6_8efc_11d2_ab21_00c04fa334b3

static final int IIDec45bfa6_8efc_11d2_ab21_00c04fa334b3
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getField

java.lang.String getField()
                          throws java.io.IOException,
                                 AutomationException
Value field.

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

setField

void setField(java.lang.String field)
              throws java.io.IOException,
                     AutomationException
Value field.

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

getNormField

java.lang.String getNormField()
                              throws java.io.IOException,
                                     AutomationException
Normalization field.

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

setNormField

void setNormField(java.lang.String field)
                  throws java.io.IOException,
                         AutomationException
Normalization field.

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

setMaxDataValue

void setMaxDataValue(double rhs1)
                     throws java.io.IOException,
                            AutomationException
Normalized maximum data value.

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

setMinDataValue

void setMinDataValue(double rhs1)
                     throws java.io.IOException,
                            AutomationException
Normalized minimum data value.

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

getMinSymbol

ISymbol getMinSymbol()
                     throws java.io.IOException,
                            AutomationException
Symbol used to draw feature with the normalized minimum data value.

Returns:
A reference to a com.esri.arcgis.display.ISymbol
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinSymbol

void setMinSymbol(ISymbol sym)
                  throws java.io.IOException,
                         AutomationException
Symbol used to draw feature with the normalized minimum data value.

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

getValueUnit

int getValueUnit()
                 throws java.io.IOException,
                        AutomationException
Units of the value field.

Returns:
A com.esri.arcgis.system.esriUnits constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setValueUnit

void setValueUnit(int unit)
                  throws java.io.IOException,
                         AutomationException
Units of the value field.

Parameters:
unit - A com.esri.arcgis.system.esriUnits constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getValueRepresentation

int getValueRepresentation()
                           throws java.io.IOException,
                                  AutomationException
Representation type of the value field.

Returns:
A com.esri.arcgis.carto.esriValueRepresentations constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setValueRepresentation

void setValueRepresentation(int rep)
                            throws java.io.IOException,
                                   AutomationException
Representation type of the value field.

Parameters:
rep - A com.esri.arcgis.carto.esriValueRepresentations constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isFlanneryCompensation

boolean isFlanneryCompensation()
                               throws java.io.IOException,
                                      AutomationException
Indicates if Flannery Compensation is applied.

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

setFlanneryCompensation

void setFlanneryCompensation(boolean flag)
                             throws java.io.IOException,
                                    AutomationException
Indicates if Flannery Compensation is applied.

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

getLegendSymbolCount

int getLegendSymbolCount()
                         throws java.io.IOException,
                                AutomationException
Number of symbols displayed in the TOC and legend.

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

setLegendSymbolCount

void setLegendSymbolCount(int num)
                          throws java.io.IOException,
                                 AutomationException
Number of symbols displayed in the TOC and legend.

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

getBackgroundSymbol

IFillSymbol getBackgroundSymbol()
                                throws java.io.IOException,
                                       AutomationException
Background fill symbol used when proportional marker symbols are draw on polygon features.

Returns:
A reference to a com.esri.arcgis.display.IFillSymbol
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackgroundSymbol

void setBackgroundSymbol(IFillSymbol sym)
                         throws java.io.IOException,
                                AutomationException
Background fill symbol used when proportional marker symbols are draw on polygon features.

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

createLegendSymbols

void createLegendSymbols()
                         throws java.io.IOException,
                                AutomationException
Creates the legend. Call after all properties have been set.

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