com.esri.arcgis.carto
Class ChartRenderer

java.lang.Object
  extended by com.esri.arcgis.carto.ChartRenderer
All Implemented Interfaces:
IBarrierProperties2, IBasicOverposterEvents, IChartRenderer, IDataExclusion, IDataExclusion2, IDataNormalization, IExportSupport, IFeatureRenderer, IIdentify, ILegendInfo, IPieChartRenderer, IRendererFields, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable, java.util.EventListener

public class ChartRenderer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IChartRenderer, IRendererFields, IDataExclusion, IDataExclusion2, IDataNormalization, IFeatureRenderer, IIdentify, ILegendInfo, IPersistStream, IPersist, IPieChartRenderer, IBarrierProperties2, IBasicOverposterEvents, IExportSupport, java.io.Externalizable

COM Class 'ChartRenderer'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'A chart renderer used to draw pie, bar, and stacked bar chart symbols.' 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 =

See Also:
Serialized Form

Field Summary
static long serialVersionUID
           
 
Fields inherited from interface com.esri.arcgis.carto.IChartRenderer
IID, IID22a98367_c48d_11d3_9f7a_00c04f6bc709, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IRendererFields
IID, IID9c7776b8_0421_11d4_9f7c_00c04f6bc709, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IDataExclusion
IID, IID3d961d65_fc94_11d1_aaca_00c04fa334b3, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IDataExclusion2
IID, IID765a9a92_f6fa_4501_a888_a793ad33e023, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IDataNormalization
IID, IID678d02a5_e3fa_11d3_9f7b_00c04f6bc709, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersistStream
IID, IID00000109_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Fields inherited from interface com.esri.arcgis.carto.IPieChartRenderer
IID, IID22a98368_c48d_11d3_9f7a_00c04f6bc709, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IBarrierProperties2
IID, IIDe2d07333_5605_4ea6_87bd_7830927452e0, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IBasicOverposterEvents
IID, IIDc4541861_5a4f_11d2_a2c0_080009b6f22b, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IExportSupport
IID, IIDf6448010_3cc8_435e_b042_540e9a328f3b, xxDummy
 
Constructor Summary
ChartRenderer()
          Constructs a ChartRenderer using ArcGIS Engine.
ChartRenderer(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ChartRenderer theChartRenderer = (ChartRenderer) obj;
 
Method Summary
 void addField(java.lang.String name, java.lang.String alias)
          Adds a field to the renderer.
 boolean canRender(IFeatureClass featClass, IDisplay display)
          Indicates if the specified feature class can be rendered on the given display.
 void clearFields()
          Removes all fields from the renderer.
 void createLegend()
          Creates the legend.
 void deleteField(java.lang.String name)
          Removes the specified field from the renderer.
 void disconnect()
          Disconnects the data from the renderer.
 void draw(IFeatureCursor cursor, int drawPhase, IDisplay display, ITrackCancel trackCancel)
          Draws features from the specified cursor on the given display.
 boolean equals(java.lang.Object o)
          Compare this object with another
 ISymbol getBaseSymbol()
          Background fill symbol, (used when chart symbols are drawn for polygon features).
 IChartSymbol getChartSymbol()
          Chart symbol object.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 java.lang.String getColorScheme()
          Color scheme (user interface property only).
 java.lang.String getExclusionClause()
          Data exclusion where clause.
 java.lang.String getExclusionDescription()
          Description for the excluded data.
 java.lang.String getExclusionLabel()
          Label for the excluded data.
 ISymbol getExclusionSymbol()
          Symbol used to draw excluded values.
 java.lang.String getField(int index)
          Field at the specified index.
 java.lang.String getFieldAlias(int index)
          Field alias at the specified index.
 int getFieldCount()
          Number of fields.
 double getFieldTotal(int index)
          Field total for the field at the specified index.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 java.lang.String getLabel()
          Chart label.
 ILegendGroup getLegendGroup(int index)
          Legend group at the specified index.
 int getLegendGroupCount()
          Number of legend groups contained by the object.
 ILegendItem getLegendItem()
          Optional.
 double getMinSize()
          Symbol size (points) corresponding to the minimum value.
 double getMinValue()
          Minimum value (used for proportional sizing).
 java.lang.String getNormalizationField()
          Normalization field.
 java.lang.String getNormalizationFieldAlias()
          Normalization field alias.
 double getNormalizationTotal()
          Total of all values (used when normalizing by percent of total).
 int getNormalizationType()
          Normalization type.
 java.lang.String getProportionalField()
          Field used to determine size of the pie chart symbols.
 java.lang.String getProportionalFieldAlias()
          Field alias for the proportional field.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 ISymbol getSymbolByFeature(IFeature feature)
          Symbol used to draw the specified feature.
 int getWeight()
          Weight of the barriers for this layer.
 int hashCode()
          the hashcode for this object
 IArray identify(IGeometry pGeom)
          Identifies objects at the specified location.
 void isDirty()
          isDirty
 boolean isFlanneryCompensation()
          Indicates if Flannery Compensation is applied.
 boolean isProportionalBySum()
          Indicates if the size of pie chart symbols is determined by the sum of the values.
 boolean isRenderPhase(int drawPhase)
          Indicates if renderer uses the specified draw phase.
 boolean isShowExclusionClass()
          Indicates if the exclusion symbol is used.
 boolean isSymbolsAreGraduated()
          Indicates if symbols are graduated.
 boolean isUseOverposter()
          Indicates if the overposter is used for positioning the chart symbols.
 void label(IBasicOverposterEventsLabelEvent theEvent)
          Fires when the label is found.
 void load(IStream pstm)
          load
 void prepareFilter(IFeatureClass fc, IQueryFilter queryFilter)
          Prepares the query filter for the rendering process.
 void queryBarriers(IDisplay display, IGeometryCollection pBarriers, IEnvelope extent, ITrackCancel trackCancel)
          List of barriers within the specified extent, or all barriers if no extent given.
 void readExternal(java.io.ObjectInput in)
           
 void release()
          Release a ChartRenderer.
 void save(IStream pstm, int fClearDirty)
          save
 void setBaseSymbolByRef(ISymbol symbol)
          Background fill symbol, (used when chart symbols are drawn for polygon features).
 void setChartSymbolByRef(IChartSymbol symbol)
          Chart symbol object.
 void setColorScheme(java.lang.String name)
          Color scheme (user interface property only).
 void setExclusionClause(java.lang.String clause)
          Data exclusion where clause.
 void setExclusionDescription(java.lang.String text)
          Description for the excluded data.
 void setExclusionLabel(java.lang.String label)
          Label for the excluded data.
 void setExclusionSetByRef(IFeatureIDSet rhs1)
          An object reference to a temporary drawing exclusion set.
 void setExclusionSymbol(ISymbol symbol)
          Symbol used to draw excluded values.
 void setExportInfoByRef(IFeatureExportInfoGenerator rhs1)
          The helper oject to generate export information.
 void setField(int index, java.lang.String name)
          Field at the specified index.
 void setFieldAlias(int index, java.lang.String name)
          Field alias at the specified index.
 void setFieldTotal(int index, double total)
          Field total for the field at the specified index.
 void setFlanneryCompensation(boolean flag)
          Indicates if Flannery Compensation is applied.
 void setLabel(java.lang.String name)
          Chart label.
 void setMinSize(double points)
          Symbol size (points) corresponding to the minimum value.
 void setMinValue(double value)
          Minimum value (used for proportional sizing).
 void setNormalizationField(java.lang.String fieldName)
          Normalization field.
 void setNormalizationFieldAlias(java.lang.String name)
          Normalization field alias.
 void setNormalizationTotal(double value)
          Total of all values (used when normalizing by percent of total).
 void setNormalizationType(int type)
          Normalization type.
 void setProportionalBySum(boolean flag)
          Indicates if the size of pie chart symbols is determined by the sum of the values.
 void setProportionalField(java.lang.String name)
          Field used to determine size of the pie chart symbols.
 void setProportionalFieldAlias(java.lang.String name)
          Field alias for the proportional field.
 void setShowExclusionClass(boolean show)
          Indicates if the exclusion symbol is used.
 void setSymbolsAreGraduated(boolean symbolsAreGraduated)
          Indicates if symbols are graduated.
 void setUseOverposter(boolean flag)
          Indicates if the overposter is used for positioning the chart symbols.
 void setWeight(int weight)
          Weight of the barriers for this layer.
 void writeExternal(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

ChartRenderer

public ChartRenderer()
              throws java.io.IOException,
                     java.net.UnknownHostException
Constructs a ChartRenderer using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

ChartRenderer

public ChartRenderer(java.lang.Object obj)
              throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ChartRenderer theChartRenderer = (ChartRenderer) obj;

Construct a ChartRenderer using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ChartRenderer.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a ChartRenderer.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getFieldTotal

public double getFieldTotal(int index)
                     throws java.io.IOException,
                            AutomationException
Field total for the field at the specified index.

Specified by:
getFieldTotal in interface IChartRenderer
Parameters:
index - The index (in)
Returns:
The total
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFieldTotal

public void setFieldTotal(int index,
                          double total)
                   throws java.io.IOException,
                          AutomationException
Field total for the field at the specified index.

Specified by:
setFieldTotal in interface IChartRenderer
Parameters:
index - The index (in)
total - The total (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getChartSymbol

public IChartSymbol getChartSymbol()
                            throws java.io.IOException,
                                   AutomationException
Chart symbol object.

Specified by:
getChartSymbol in interface IChartRenderer
Returns:
A reference to a com.esri.arcgis.display.IChartSymbol
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setChartSymbolByRef

public void setChartSymbolByRef(IChartSymbol symbol)
                         throws java.io.IOException,
                                AutomationException
Chart symbol object.

Specified by:
setChartSymbolByRef in interface IChartRenderer
Parameters:
symbol - A reference to a com.esri.arcgis.display.IChartSymbol (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBaseSymbol

public ISymbol getBaseSymbol()
                      throws java.io.IOException,
                             AutomationException
Background fill symbol, (used when chart symbols are drawn for polygon features).

Specified by:
getBaseSymbol in interface IChartRenderer
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.

setBaseSymbolByRef

public void setBaseSymbolByRef(ISymbol symbol)
                        throws java.io.IOException,
                               AutomationException
Background fill symbol, (used when chart symbols are drawn for polygon features).

Specified by:
setBaseSymbolByRef in interface IChartRenderer
Parameters:
symbol - 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.

getColorScheme

public java.lang.String getColorScheme()
                                throws java.io.IOException,
                                       AutomationException
Color scheme (user interface property only).

Specified by:
getColorScheme in interface IChartRenderer
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setColorScheme

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

Specified by:
setColorScheme in interface IChartRenderer
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabel

public java.lang.String getLabel()
                          throws java.io.IOException,
                                 AutomationException
Chart label.

Specified by:
getLabel in interface IChartRenderer
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabel

public void setLabel(java.lang.String name)
              throws java.io.IOException,
                     AutomationException
Chart label.

Specified by:
setLabel in interface IChartRenderer
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseOverposter

public boolean isUseOverposter()
                        throws java.io.IOException,
                               AutomationException
Indicates if the overposter is used for positioning the chart symbols.

Specified by:
isUseOverposter in interface IChartRenderer
Returns:
The flag
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseOverposter

public void setUseOverposter(boolean flag)
                      throws java.io.IOException,
                             AutomationException
Indicates if the overposter is used for positioning the chart symbols.

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

createLegend

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

Specified by:
createLegend in interface IChartRenderer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFieldCount

public int getFieldCount()
                  throws java.io.IOException,
                         AutomationException
Number of fields.

Specified by:
getFieldCount in interface IRendererFields
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getField

public java.lang.String getField(int index)
                          throws java.io.IOException,
                                 AutomationException
Field at the specified index.

Specified by:
getField in interface IRendererFields
Parameters:
index - The index (in)
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setField

public void setField(int index,
                     java.lang.String name)
              throws java.io.IOException,
                     AutomationException
Field at the specified index.

Specified by:
setField in interface IRendererFields
Parameters:
index - The index (in)
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFieldAlias

public java.lang.String getFieldAlias(int index)
                               throws java.io.IOException,
                                      AutomationException
Field alias at the specified index.

Specified by:
getFieldAlias in interface IRendererFields
Parameters:
index - The index (in)
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFieldAlias

public void setFieldAlias(int index,
                          java.lang.String name)
                   throws java.io.IOException,
                          AutomationException
Field alias at the specified index.

Specified by:
setFieldAlias in interface IRendererFields
Parameters:
index - The index (in)
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addField

public void addField(java.lang.String name,
                     java.lang.String alias)
              throws java.io.IOException,
                     AutomationException
Adds a field to the renderer.

Specified by:
addField in interface IRendererFields
Parameters:
name - The name (in)
alias - The alias (in, optional, pass null if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteField

public void deleteField(java.lang.String name)
                 throws java.io.IOException,
                        AutomationException
Removes the specified field from the renderer.

Specified by:
deleteField in interface IRendererFields
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearFields

public void clearFields()
                 throws java.io.IOException,
                        AutomationException
Removes all fields from the renderer.

Specified by:
clearFields in interface IRendererFields
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExclusionClause

public java.lang.String getExclusionClause()
                                    throws java.io.IOException,
                                           AutomationException
Data exclusion where clause.

Specified by:
getExclusionClause in interface IDataExclusion
Returns:
The clause
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExclusionClause

public void setExclusionClause(java.lang.String clause)
                        throws java.io.IOException,
                               AutomationException
Data exclusion where clause.

Specified by:
setExclusionClause in interface IDataExclusion
Parameters:
clause - The clause (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExclusionSymbol

public ISymbol getExclusionSymbol()
                           throws java.io.IOException,
                                  AutomationException
Symbol used to draw excluded values.

Specified by:
getExclusionSymbol in interface IDataExclusion
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.

setExclusionSymbol

public void setExclusionSymbol(ISymbol symbol)
                        throws java.io.IOException,
                               AutomationException
Symbol used to draw excluded values.

Specified by:
setExclusionSymbol in interface IDataExclusion
Parameters:
symbol - 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.

isShowExclusionClass

public boolean isShowExclusionClass()
                             throws java.io.IOException,
                                    AutomationException
Indicates if the exclusion symbol is used.

Specified by:
isShowExclusionClass in interface IDataExclusion
Returns:
The show
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowExclusionClass

public void setShowExclusionClass(boolean show)
                           throws java.io.IOException,
                                  AutomationException
Indicates if the exclusion symbol is used.

Specified by:
setShowExclusionClass in interface IDataExclusion
Parameters:
show - The show (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExclusionLabel

public java.lang.String getExclusionLabel()
                                   throws java.io.IOException,
                                          AutomationException
Label for the excluded data.

Specified by:
getExclusionLabel in interface IDataExclusion
Returns:
The label
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExclusionLabel

public void setExclusionLabel(java.lang.String label)
                       throws java.io.IOException,
                              AutomationException
Label for the excluded data.

Specified by:
setExclusionLabel in interface IDataExclusion
Parameters:
label - The label (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExclusionDescription

public java.lang.String getExclusionDescription()
                                         throws java.io.IOException,
                                                AutomationException
Description for the excluded data.

Specified by:
getExclusionDescription in interface IDataExclusion
Returns:
The text
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExclusionDescription

public void setExclusionDescription(java.lang.String text)
                             throws java.io.IOException,
                                    AutomationException
Description for the excluded data.

Specified by:
setExclusionDescription in interface IDataExclusion
Parameters:
text - The text (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

disconnect

public void disconnect()
                throws java.io.IOException,
                       AutomationException
Disconnects the data from the renderer.

Specified by:
disconnect in interface IDataExclusion2
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNormalizationField

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

Specified by:
getNormalizationField in interface IDataNormalization
Returns:
The fieldName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNormalizationField

public void setNormalizationField(java.lang.String fieldName)
                           throws java.io.IOException,
                                  AutomationException
Normalization field.

Specified by:
setNormalizationField in interface IDataNormalization
Parameters:
fieldName - The fieldName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNormalizationFieldAlias

public java.lang.String getNormalizationFieldAlias()
                                            throws java.io.IOException,
                                                   AutomationException
Normalization field alias.

Specified by:
getNormalizationFieldAlias in interface IDataNormalization
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNormalizationFieldAlias

public void setNormalizationFieldAlias(java.lang.String name)
                                throws java.io.IOException,
                                       AutomationException
Normalization field alias.

Specified by:
setNormalizationFieldAlias in interface IDataNormalization
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNormalizationType

public int getNormalizationType()
                         throws java.io.IOException,
                                AutomationException
Normalization type.

Specified by:
getNormalizationType in interface IDataNormalization
Returns:
A com.esri.arcgis.carto.esriDataNormalization constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNormalizationType

public void setNormalizationType(int type)
                          throws java.io.IOException,
                                 AutomationException
Normalization type.

Specified by:
setNormalizationType in interface IDataNormalization
Parameters:
type - A com.esri.arcgis.carto.esriDataNormalization constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNormalizationTotal

public double getNormalizationTotal()
                             throws java.io.IOException,
                                    AutomationException
Total of all values (used when normalizing by percent of total).

Specified by:
getNormalizationTotal in interface IDataNormalization
Returns:
The value
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNormalizationTotal

public void setNormalizationTotal(double value)
                           throws java.io.IOException,
                                  AutomationException
Total of all values (used when normalizing by percent of total).

Specified by:
setNormalizationTotal in interface IDataNormalization
Parameters:
value - The value (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canRender

public boolean canRender(IFeatureClass featClass,
                         IDisplay display)
                  throws java.io.IOException,
                         AutomationException
Indicates if the specified feature class can be rendered on the given display.

Remarks

If the renderer is not applicable to a feature layer, then it can return False in response to a CanRender method. For example, the dot-density renderer is only applicable to polygon feature layers and returns False in response to other feature layers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
canRender in interface IFeatureRenderer
Parameters:
featClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
display - A reference to a com.esri.arcgis.display.IDisplay (in)
Returns:
The result
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

prepareFilter

public void prepareFilter(IFeatureClass fc,
                          IQueryFilter queryFilter)
                   throws java.io.IOException,
                          AutomationException
Prepares the query filter for the rendering process.

Remarks

This method is called prior to the Draw method and gives the renderer a chance to adjust the query filter to incorporate extra constraints. For example, if a particular field is required for the renderer, it would add this field to the filter to ensure it is accessible during the Draw method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
prepareFilter in interface IFeatureRenderer
Parameters:
fc - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IFeatureCursor cursor,
                 int drawPhase,
                 IDisplay display,
                 ITrackCancel trackCancel)
          throws java.io.IOException,
                 AutomationException
Draws features from the specified cursor on the given display.

Remarks

This method is typically called by the framework to renderer features to a display. This could be in response to a refresh on the map. This method typically iterates through all the features and renders each feature with an appropriate symbol.

An individual feature is typically drawn by calling the Draw method on the feature's IFeatureDraw with the symbol created by the renderer. However, when writing a custom feature renderer you can draw anything you want using a number of different methods. To learn more see the section on writing a custom feature renderer in Extending ArcObjects.

To allow complex rendering to be canceled halfway through a draw, the renderer typically checks the TrackCancel object after each feature or set of features. If a cancel action has occurred, the renderer will exit.

There are three drawing phases: selection, annotation, and geography, and this method can be called by the framework up to three times. With the exception of the selection phase, this method will only be called for a particular draw phase if the call by the framework to RenderPhase returns true for that phase.

Feature renderers typically only draw features during the geography phase, though in some cases features are drawn in the annotation phase. Take for example a case where proportional symbols are drawn for polygon features. The ProportionalSymbolRenderer draws the background fill symbol during the geography phase and the proportionally sized marker symbol during the annotation phase.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
draw in interface IFeatureRenderer
Parameters:
cursor - A reference to a com.esri.arcgis.geodatabase.IFeatureCursor (in)
drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)
display - A reference to a com.esri.arcgis.display.IDisplay (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSymbolByFeature

public ISymbol getSymbolByFeature(IFeature feature)
                           throws java.io.IOException,
                                  AutomationException
Symbol used to draw the specified feature.

Product Availability

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

Specified by:
getSymbolByFeature in interface IFeatureRenderer
Parameters:
feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)
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.

isRenderPhase

public boolean isRenderPhase(int drawPhase)
                      throws java.io.IOException,
                             AutomationException
Indicates if renderer uses the specified draw phase.

Product Availability

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

Specified by:
isRenderPhase in interface IFeatureRenderer
Parameters:
drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)
Returns:
The result
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExclusionSetByRef

public void setExclusionSetByRef(IFeatureIDSet rhs1)
                          throws java.io.IOException,
                                 AutomationException
An object reference to a temporary drawing exclusion set.

Description

The list of feature IDs to be excluded from drawing.

Remarks

Some feature renderers support IDataExclusion which allows you to build a where clause to exclude features.

Exclusion prevents features from drawing. To prevent features from drawing as well as from appearing in tables and in query results, set a layer definition query using IFeatureLayerDefinition.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setExclusionSetByRef in interface IFeatureRenderer
Parameters:
rhs1 - A reference to a com.esri.arcgis.carto.IFeatureIDSet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

identify

public IArray identify(IGeometry pGeom)
                throws java.io.IOException,
                       AutomationException
Identifies objects at the specified location.

Remarks

When the IIdentify interface is on a map layer, the Identify method returns an array of FeatureIdentifyObject objects.

On a FeatureIdentifyObject, you can do a QI to the IIdentifyObj interface to get more information about the identified feature. The IIdentifyObj interface returns the window handle, layer, and name of the feature; it has methods to flash the feature in the display and to display a context menu at the Identify location.

This method performs an identify operation with the provided geometry. When identifying layers, typically a small envelope is passed in rather than a point to account for differences in the precision of the display and the feature geometry.


Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
identify in interface IIdentify
Parameters:
pGeom - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLegendGroupCount

public int getLegendGroupCount()
                        throws java.io.IOException,
                               AutomationException
Number of legend groups contained by the object.

Remarks

The number of legend groups is determined by the implementation of the renderer, consequently this property is read only. For example, SimpleRenderer has one group, while a BiUniqueValueRenderer has any number of groups.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLegendGroupCount in interface ILegendInfo
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLegendGroup

public ILegendGroup getLegendGroup(int index)
                            throws java.io.IOException,
                                   AutomationException
Legend group at the specified index.

Product Availability

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

Specified by:
getLegendGroup in interface ILegendInfo
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.carto.ILegendGroup
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLegendItem

public ILegendItem getLegendItem()
                          throws java.io.IOException,
                                 AutomationException
Optional. Defines legend formatting for layer rendered with this object.

Remarks

Layer or renderer legend information is further formatted for display in ArcMap legends. A renderer can override this formatting by returning a LegendItem for this property. ESRI renderers typically do not return anything for this property. With this configuration, legend formatting becomes a user or developer choice on the legend object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLegendItem in interface ILegendInfo
Returns:
A reference to a com.esri.arcgis.carto.ILegendItem
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSymbolsAreGraduated

public boolean isSymbolsAreGraduated()
                              throws java.io.IOException,
                                     AutomationException
Indicates if symbols are graduated.

Description

Indicates whether the symbols used for a layer or renderer's legend vary by size.

Remarks

For example the proportional symbol renderer returns True for this property.

You can use this property to distinguish between a layer symbolized with graduated color or graduated symbol type layer symbology. Both of these symbolizations use a ClassBreaksRenderer, but only a graduated symbol symbolization will return True for this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isSymbolsAreGraduated in interface ILegendInfo
Returns:
The symbolsAreGraduated
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSymbolsAreGraduated

public void setSymbolsAreGraduated(boolean symbolsAreGraduated)
                            throws java.io.IOException,
                                   AutomationException
Indicates if symbols are graduated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSymbolsAreGraduated in interface ILegendInfo
Parameters:
symbolsAreGraduated - The symbolsAreGraduated (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException
isDirty

Specified by:
isDirty in interface IPersistStream
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException
load

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException
save

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException
getSizeMax

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException
getClassID

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getProportionalField

public java.lang.String getProportionalField()
                                      throws java.io.IOException,
                                             AutomationException
Field used to determine size of the pie chart symbols.

Specified by:
getProportionalField in interface IPieChartRenderer
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setProportionalField

public void setProportionalField(java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException
Field used to determine size of the pie chart symbols.

Specified by:
setProportionalField in interface IPieChartRenderer
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getProportionalFieldAlias

public java.lang.String getProportionalFieldAlias()
                                           throws java.io.IOException,
                                                  AutomationException
Field alias for the proportional field.

Specified by:
getProportionalFieldAlias in interface IPieChartRenderer
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setProportionalFieldAlias

public void setProportionalFieldAlias(java.lang.String name)
                               throws java.io.IOException,
                                      AutomationException
Field alias for the proportional field.

Specified by:
setProportionalFieldAlias in interface IPieChartRenderer
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isProportionalBySum

public boolean isProportionalBySum()
                            throws java.io.IOException,
                                   AutomationException
Indicates if the size of pie chart symbols is determined by the sum of the values.

Specified by:
isProportionalBySum in interface IPieChartRenderer
Returns:
The flag
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setProportionalBySum

public void setProportionalBySum(boolean flag)
                          throws java.io.IOException,
                                 AutomationException
Indicates if the size of pie chart symbols is determined by the sum of the values.

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

getMinValue

public double getMinValue()
                   throws java.io.IOException,
                          AutomationException
Minimum value (used for proportional sizing).

Specified by:
getMinValue in interface IPieChartRenderer
Returns:
The value
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinValue

public void setMinValue(double value)
                 throws java.io.IOException,
                        AutomationException
Minimum value (used for proportional sizing).

Specified by:
setMinValue in interface IPieChartRenderer
Parameters:
value - The value (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinSize

public double getMinSize()
                  throws java.io.IOException,
                         AutomationException
Symbol size (points) corresponding to the minimum value.

Specified by:
getMinSize in interface IPieChartRenderer
Returns:
The points
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinSize

public void setMinSize(double points)
                throws java.io.IOException,
                       AutomationException
Symbol size (points) corresponding to the minimum value.

Specified by:
setMinSize in interface IPieChartRenderer
Parameters:
points - The points (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isFlanneryCompensation

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

Specified by:
isFlanneryCompensation in interface IPieChartRenderer
Returns:
The flag
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFlanneryCompensation

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

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

getWeight

public int getWeight()
              throws java.io.IOException,
                     AutomationException
Weight of the barriers for this layer.

Specified by:
getWeight in interface IBarrierProperties2
Returns:
The weight
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWeight

public void setWeight(int weight)
               throws java.io.IOException,
                      AutomationException
Weight of the barriers for this layer.

Specified by:
setWeight in interface IBarrierProperties2
Parameters:
weight - The weight (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryBarriers

public void queryBarriers(IDisplay display,
                          IGeometryCollection pBarriers,
                          IEnvelope extent,
                          ITrackCancel trackCancel)
                   throws java.io.IOException,
                          AutomationException
List of barriers within the specified extent, or all barriers if no extent given.

Specified by:
queryBarriers in interface IBarrierProperties2
Parameters:
display - A reference to a com.esri.arcgis.display.IDisplay (in)
pBarriers - A reference to a com.esri.arcgis.geometry.IGeometryCollection (in)
extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

label

public void label(IBasicOverposterEventsLabelEvent theEvent)
           throws java.io.IOException,
                  AutomationException
Fires when the label is found.

Specified by:
label in interface IBasicOverposterEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExportInfoByRef

public void setExportInfoByRef(IFeatureExportInfoGenerator rhs1)
                        throws java.io.IOException,
                               AutomationException
The helper oject to generate export information.

Specified by:
setExportInfoByRef in interface IExportSupport
Parameters:
rhs1 - A reference to a com.esri.arcgis.carto.IFeatureExportInfoGenerator (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException