com.esri.arcgis.carto.ProportionalSymbolRenderer
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public class ProportionalSymbolRenderer
A proportional symbol renderer, used to draw symbols of varying size for each feature, sized in proportion to a field value.
Use this renderer to represent quantitative data for features. With this renderer, symbol size is exactly proportional to the data value.
An example of using the proportional-value renderer is where you have map tree locations as points and an attribute reflecting the radius of the tree canopy. By using proportional circles, the trees can be depicted by circles reflecting theactual ground covered by the tree.
Another application is a population map; the area of a circular marker can directly relate to the population value.
Proportional symbols also apply well to line symbology; a river could be symbolized with a network of lines with different widths reflecting the river flow.
Known vs. Unknown Data Units
There are really two uses of proportional symbol rendering:
First, you can have a data field that represents an actual distance in the real world, such as the radius of a tree canopy in meters, or the width (actually diameter) of a water main in inches. In this case your units are known and you can use a ProportionalSymbolRenderer to draw a symbol on your map for each feature such that the area occupied by the feature on the map represents the actual area occupied in the real world.
Second, you may have a data field that represents a non-distance quantitiy, for example you might have county data and know the population of each county. This value does not represent a real world distance so the units are said to be unknown. In this case you can use the ProportionalSymbolRenderer to represent the relative population of each county. This is done by mapping a minimum symbol size, specified by MinSymbol, to the minimum data value of the population field. The MinSymbol is then scaled up proportionally based on the relative difference between the minimum population value and the value for a given county feature.
To learn more, see IProportionalSymbolRenderer::ValueUnit and IProportionalSymbolRenderer::ValueRepresentation.
| Constructor Summary | |
|---|---|
ProportionalSymbolRenderer()
Constructs a ProportionalSymbolRenderer using ArcGIS Engine. |
|
ProportionalSymbolRenderer(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. ProportionalSymbolRenderer theProportionalSymbolRenderer = (ProportionalSymbolRenderer) obj; |
|
| Method Summary | |
|---|---|
boolean |
canRender(IFeatureClass featClass,
IDisplay display)
Indicates if the specified feature class can be rendered on the given display. |
void |
createLegendSymbols()
Creates the legend. |
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(Object o)
Compare this object with another |
IFillSymbol |
getBackgroundSymbol()
Background fill symbol used when proportional marker symbols are draw on polygon features. |
void |
getClassID(GUID[] pClassID)
getClassID |
static String |
getClsid()
getClsid. |
String |
getExclusionClause()
Data exclusion where clause. |
String |
getExclusionDescription()
Description for the excluded data. |
String |
getExclusionLabel()
Label for the excluded data. |
ISymbol |
getExclusionSymbol()
Symbol used to draw excluded values. |
String |
getField()
Value field. |
ILegendGroup |
getLegendGroup(int index)
Legend group at the specified index. |
int |
getLegendGroupCount()
Number of legend groups contained by the object. |
ILegendItem |
getLegendItem()
Optional. |
int |
getLegendSymbolCount()
Number of symbols displayed in the TOC and legend. |
ISymbol |
getMinSymbol()
Symbol used to draw feature with the normalized minimum data value. |
String |
getNormalizationField()
Normalization field. |
String |
getNormalizationFieldAlias()
Normalization field alias. |
double |
getNormalizationTotal()
Total of all values (used when normalizing by percent of total). |
int |
getNormalizationType()
Normalization type. |
String |
getNormField()
Normalization field. |
String |
getRotationField()
Rotation field. |
int |
getRotationType()
Rotation type. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
ISymbol |
getSymbolByFeature(IFeature feature)
Symbol used to draw the specified feature. |
void |
getSymbolRotation3DExpressions(String[] pExpressionX,
String[] pExpressionY,
String[] pExpressionZ)
Gets expressions for rotation about each axis. |
int |
getSymbolRotation3DFlags()
Gets rotation flags composed of enum esriSymbolRotation3DFlags. |
void |
getSymbolRotation3DFlags2(int[] pFlagX,
int[] pFlagY,
int[] pFlagZ)
Gets one flag for each axis. |
void |
getSymbolRotation3DRandomRanges(double[] pMinRotationX,
double[] pMinRotationY,
double[] pMinRotationZ,
double[] pMaxRotationX,
double[] pMaxRotationY,
double[] pMaxRotationZ)
Gets rotation range for each axis (for random rotation). |
int |
getSymbolRotation3DRotationTypeZ()
Gets rotation type (geographic or arithmetic) about the Z axis (hardcoded arithmetic about other axes). |
int |
getValueRepresentation()
Representation type of the value field. |
int |
getValueUnit()
Units of the value field. |
int |
getWeight()
Weight of the barriers for this layer. |
int |
hashCode()
the hashcode for this object |
void |
isDirty()
isDirty |
boolean |
isFlanneryCompensation()
Indicates if Flannery Compensation is applied. |
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. |
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(ObjectInput in)
|
void |
save(IStream pstm,
int fClearDirty)
save |
void |
setBackgroundSymbol(IFillSymbol sym)
Background fill symbol used when proportional marker symbols are draw on polygon features. |
void |
setExclusionClause(String clause)
Data exclusion where clause. |
void |
setExclusionDescription(String text)
Description for the excluded data. |
void |
setExclusionLabel(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(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 |
setNormalizationField(String fieldName)
Normalization field. |
void |
setNormalizationFieldAlias(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 |
setNormField(String field)
Normalization field. |
void |
setRotationField(String fieldName)
Rotation field. |
void |
setRotationType(int type)
Rotation type. |
void |
setShowExclusionClass(boolean show)
Indicates if the exclusion symbol is used. |
void |
setSymbolRotation3DExpressions(String expressionX,
String expressionY,
String expressionZ)
Sets expressions for rotation about each axis. |
void |
setSymbolRotation3DFlags(int pFlags)
Gets rotation flags composed of enum esriSymbolRotation3DFlags. |
void |
setSymbolRotation3DFlags2(int flagX,
int flagY,
int flagZ)
Sets one flag for each axis. |
void |
setSymbolRotation3DRandomRanges(double minRotationX,
double minRotationY,
double minRotationZ,
double maxRotationX,
double maxRotationY,
double maxRotationZ)
Sets rotation range for each axis (for random rotation). |
void |
setSymbolRotation3DRotationTypeZ(int pType)
Gets rotation type (geographic or arithmetic) about the Z axis (hardcoded arithmetic about other axes). |
void |
setSymbolsAreGraduated(boolean symbolsAreGraduated)
Indicates if symbols are graduated. |
void |
setValueRepresentation(int rep)
Representation type of the value field. |
void |
setValueUnit(int unit)
Units of the value field. |
void |
setWeight(int weight)
Weight of the barriers for this layer. |
void |
writeExternal(ObjectOutput out)
|
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
|---|
getJintegraDispatch, release |
| Constructor Detail |
|---|
public ProportionalSymbolRenderer()
throws IOException,
UnknownHostException
IOException - if there are interop problems
UnknownHostException - if there are interop problems
public ProportionalSymbolRenderer(Object obj)
throws IOException
ProportionalSymbolRenderer theProportionalSymbolRenderer = (ProportionalSymbolRenderer) obj;
obj to ProportionalSymbolRenderer.
obj - an object returned from ArcGIS Engine or Server
IOException - if there are interop problems| Method Detail |
|---|
public static String getClsid()
public boolean equals(Object o)
equals in class Objectpublic int hashCode()
hashCode in class Object
public boolean canRender(IFeatureClass featClass,
IDisplay display)
throws IOException,
AutomationException
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.
canRender in interface IFeatureRendererfeatClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)display - A reference to a com.esri.arcgis.display.IDisplay (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void prepareFilter(IFeatureClass fc,
IQueryFilter queryFilter)
throws IOException,
AutomationException
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.
prepareFilter in interface IFeatureRendererfc - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void draw(IFeatureCursor cursor,
int drawPhase,
IDisplay display,
ITrackCancel trackCancel)
throws IOException,
AutomationException
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.
draw in interface IFeatureRenderercursor - 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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISymbol getSymbolByFeature(IFeature feature)
throws IOException,
AutomationException
getSymbolByFeature in interface IFeatureRendererfeature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isRenderPhase(int drawPhase)
throws IOException,
AutomationException
isRenderPhase in interface IFeatureRendererdrawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setExclusionSetByRef(IFeatureIDSet rhs1)
throws IOException,
AutomationException
The list of feature IDs to be excluded from drawing.
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.
setExclusionSetByRef in interface IFeatureRendererrhs1 - A reference to a com.esri.arcgis.carto.IFeatureIDSet (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getField()
throws IOException,
AutomationException
The name of the numeric field used to determine the size of the symbol drawn for each feature on the map.
The ProportionalSymbolRenderer can only draw features with with field values greater than zero. If Field contains values less than or equal to zero, you should use IDataExclusion to exclude these features from drawing.
To use normalization specify a field name for NormField.
getField in interface IProportionalSymbolRendererIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setField(String field)
throws IOException,
AutomationException
setField in interface IProportionalSymbolRendererfield - The field (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getNormField()
throws IOException,
AutomationException
Similar to the
ClassBreaksRenderer, the
ProportionalSymbolRenderer you can specify a
normalization field through the NormField
property. This is exactly the same as setting the field via
IDataNormalization::NormalizationField property.
Data is normalized prior to caculating symbol
sizes.
getNormField in interface IProportionalSymbolRendererIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setNormField(String field)
throws IOException,
AutomationException
setNormField in interface IProportionalSymbolRendererfield - The field (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMaxDataValue(double rhs1)
throws IOException,
AutomationException
This property represents the largest possible value in the data. This property does not at all affect the map symbolization, but is only used to help determine the structure of the renderers entry in the table of contents and legend if applicable.
This property is only used if ValueUnit = esriUnknownUnits. In this case the set of symbols to be shown in the renderer legend entry is determined based on the values of these properties: MinSymbol/MinDataValue, MaxDataValue, and LegendSymbolCount which is the desired number of symbols to be shown in the legend entry. Be sure to set these properties before calling CreateLegendSymbol, which refreshes the renderer's legend entry.
If ValueUnit is some known data unit, then only the MinSymbol is shown in the legend and MaxDataValue is not used.
setMaxDataValue in interface IProportionalSymbolRendererrhs1 - The rhs1 (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMinDataValue(double rhs1)
throws IOException,
AutomationException
setMinDataValue in interface IProportionalSymbolRendererrhs1 - The rhs1 (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISymbol getMinSymbol()
throws IOException,
AutomationException
This is the symbol used to display the data. This can be a marker or line symbol.
MinSymbol is the base symbol used by the proportional symbol renderer, and it can be a line or marker symbol. For each feature in the data, MinSymbol is resized and used to represent the data value in Field. The rules for resizing of MinSymbol are controlled by the settings for ValueUnit and ValueRepresentation.
Marker symbols can be used with both point and polygon data. In the polygon data case, markers are drawn at the center of each feature. BackgroundSymbol provides access to the fill symbol used to draw the actual shape of the underlying polygon features.
getMinSymbol in interface IProportionalSymbolRendererIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMinSymbol(ISymbol sym)
throws IOException,
AutomationException
setMinSymbol in interface IProportionalSymbolRenderersym - A reference to a com.esri.arcgis.display.ISymbol (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getValueUnit()
throws IOException,
AutomationException
This property specifies the real world distance units that the data in Field represent.
Known Units
If the data in Field represent an actual distance in the real world, and you know the units for the data, then you should set ValueUnit to these units. For example, for your tree point data you might have measured the radius of each tree canopy in meters and have this stored in the field "Canopy". In this scenario you should set ValueUnit = esriMeters and also set ValueRepresentation = esriValueRepRadius. See ValueRepresentation for more information about how symbols are scaled to data values. Also, in this case you do not need to set MinDataValue.
Unknown Units
If the data in Field does not represent an actual distance in the real world, then you should set ValueUnit = esriUnknownUnits. In this case you need to set MinDataValue to the data value corresponding to the size of the symbol set for MinSymbol.
In the marker symbol case, a feature with value that is twice the MinDataValue will have a symbol with an area twice as big as the MinSymbol. An assumption is made that the marker symbol is square for this calculation. Also, for marker symbols with unknown units, an appearance compensation factor can be applied by setting FlanneryCompensation = True. Empirical testing has shown that people tend to underestimate differences in area when visually comparing two marker symbols. Therefore, this factor increases the difference in area between a smaller symbol and a a larger symbol as the symbols get larger.
In the line symbol case, a feature with value that is twice the MinDataValue will have a width that is twice as wide as the MinSymbol.
getValueUnit in interface IProportionalSymbolRendererIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setValueUnit(int unit)
throws IOException,
AutomationException
setValueUnit in interface IProportionalSymbolRendererunit - A com.esri.arcgis.system.esriUnits constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getValueRepresentation()
throws IOException,
AutomationException
ValueRepresentation together with ValueUnit specifies how data values are mapped to symbol sizes by the renderer. However, the way that ValueRepresentation affects this mapping is the same regardless of the ValueUnit:
Marker symbols can be proportional by radius or area. Note that marker symbols should be circular or square for these settings to correctly apply.
Line symbols can be proportional by width or distance from the center line (one half the width).
If ValueUnit = esriUnknownUnits, then marker symbols are proportional by area and line symbols are proportional by width.
getValueRepresentation in interface IProportionalSymbolRendererIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setValueRepresentation(int rep)
throws IOException,
AutomationException
setValueRepresentation in interface IProportionalSymbolRendererrep - A com.esri.arcgis.carto.esriValueRepresentations constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isFlanneryCompensation()
throws IOException,
AutomationException
This property is only used if ValueUnit is some known set of units and MinSymbol is a marker symbol.
This property is a flag that indicates whether or not a Flannery compensation factor is applied to the marker symbol sizes calculated by the renderer. By setting this property to True you are enabling the application of this compensation factor.
Empirical testing has shown that people tend to underestimate differences in area when visually comparing two marker symbols. Therefore, the Flannery compensation factor increases the difference in area between a smaller symbol and a a larger symbol as the symbols get larger. It is generally accepted that this factor should be applied when sizing marker symbols proportionally or in a graduated fashion.
isFlanneryCompensation in interface IProportionalSymbolRendererIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setFlanneryCompensation(boolean flag)
throws IOException,
AutomationException
setFlanneryCompensation in interface IProportionalSymbolRendererflag - The flag (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getLegendSymbolCount()
throws IOException,
AutomationException
The ProportionalSymbolRenderer does not use a fixed set of symbols, and so the legend information for the renderer must be refreshed by calling CreateLegendSymbols after changes are made to renderer properties.
This property represents the number of desired symbol sizes to be shown in the legend entry for the renderer. The property is onl used if ValueUnit = esriUnknownUnits. In this case the set of symbols to be shown in the table of contents, and legend if applicable is determined based on the values of these properties: MinSymbol/MinDataValue, MaxDataValue which is the largest possible value in the data, and LegendSymbolCount. Be sure to set these properties before calling CreateLegendSymbol.
If ValueUnit is some known data unit, then only the MinSymbol is shown in the legend and LegendSymbolCount is not used.
getLegendSymbolCount in interface IProportionalSymbolRendererIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setLegendSymbolCount(int num)
throws IOException,
AutomationException
setLegendSymbolCount in interface IProportionalSymbolRenderernum - The num (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IFillSymbol getBackgroundSymbol()
throws IOException,
AutomationException
This is the fill symbol used to draw the actual shape of polygon features when the renderer is applied to a polygon feature layer. In this situation, the MinSymbol is a marker symbol and is drawn at the center of each poylgon feature.
getBackgroundSymbol in interface IProportionalSymbolRendererIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setBackgroundSymbol(IFillSymbol sym)
throws IOException,
AutomationException
setBackgroundSymbol in interface IProportionalSymbolRenderersym - A reference to a com.esri.arcgis.display.IFillSymbol (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void createLegendSymbols()
throws IOException,
AutomationException
The
ProportionalSymbolRenderer does not use a fixed
set of symbols, and so the legend information for the renderer must
be refreshed by calling this method after changes are made to
renderer properties.
If
ValueUnit = esriUnknownUnits then a set
number of symbols will be shown in the table of contents, and
legend if applicable. This set will be determined based on
several properties:
MinSymbol/MinDataValue,
MaxDataValue which is the largest possible value
in the data, and LegendSymbolCount which is the
number of symbols desired in the renderer's legend entry. Be sure
to set these properties before calling
CreateLegendSymbol.
If
ValueUnit is some known data unit, then only the
MinSymbol is shown in the
legend.
createLegendSymbols in interface IProportionalSymbolRendererIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getExclusionClause()
throws IOException,
AutomationException
getExclusionClause in interface IDataExclusionIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setExclusionClause(String clause)
throws IOException,
AutomationException
setExclusionClause in interface IDataExclusionclause - The clause (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISymbol getExclusionSymbol()
throws IOException,
AutomationException
getExclusionSymbol in interface IDataExclusionIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setExclusionSymbol(ISymbol symbol)
throws IOException,
AutomationException
setExclusionSymbol in interface IDataExclusionsymbol - A reference to a com.esri.arcgis.display.ISymbol (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isShowExclusionClass()
throws IOException,
AutomationException
Setting ShowExclusionClass to TRUE creates a new LegendClass that appears in the TOC containing the ExclusionSymbol, ExclusionLabel, and ExclusionDescription. Also, use this property to control whether the ExclusionSymbol is drawn on the map. IDataExclusion provides no mechanism to make the symbol appear on the map, but not in the TOC.
isShowExclusionClass in interface IDataExclusionIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setShowExclusionClass(boolean show)
throws IOException,
AutomationException
setShowExclusionClass in interface IDataExclusionshow - The show (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getExclusionLabel()
throws IOException,
AutomationException
getExclusionLabel in interface IDataExclusionIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setExclusionLabel(String label)
throws IOException,
AutomationException
setExclusionLabel in interface IDataExclusionlabel - The label (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getExclusionDescription()
throws IOException,
AutomationException
getExclusionDescription in interface IDataExclusionIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setExclusionDescription(String text)
throws IOException,
AutomationException
setExclusionDescription in interface IDataExclusiontext - The text (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void disconnect()
throws IOException,
AutomationException
disconnect in interface IDataExclusion2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getLegendGroupCount()
throws IOException,
AutomationException
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.
getLegendGroupCount in interface ILegendInfoIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ILegendGroup getLegendGroup(int index)
throws IOException,
AutomationException
getLegendGroup in interface ILegendInfoindex - The index (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ILegendItem getLegendItem()
throws IOException,
AutomationException
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.
getLegendItem in interface ILegendInfoIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isSymbolsAreGraduated()
throws IOException,
AutomationException
Indicates whether the symbols used for a layer or renderer's legend vary by size.
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.
isSymbolsAreGraduated in interface ILegendInfoIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSymbolsAreGraduated(boolean symbolsAreGraduated)
throws IOException,
AutomationException
setSymbolsAreGraduated in interface ILegendInfosymbolsAreGraduated - The symbolsAreGraduated (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void isDirty()
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty in interface IPersistStreamIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void load(IStream pstm)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void save(IStream pstm,
int fClearDirty)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)fClearDirty - The fClearDirty (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax in interface IPersistStreampcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getClassID(GUID[] pClassID)
throws IOException,
AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID in interface IPersistpClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getRotationField()
throws IOException,
AutomationException
getRotationField in interface IRotationRendererIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setRotationField(String fieldName)
throws IOException,
AutomationException
setRotationField in interface IRotationRendererfieldName - The fieldName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getRotationType()
throws IOException,
AutomationException
getRotationType in interface IRotationRendererIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setRotationType(int type)
throws IOException,
AutomationException
setRotationType in interface IRotationRenderertype - A com.esri.arcgis.carto.esriSymbolRotationType constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getSymbolRotation3DFlags()
throws IOException,
AutomationException
getSymbolRotation3DFlags in interface IRotationRenderer2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSymbolRotation3DFlags(int pFlags)
throws IOException,
AutomationException
setSymbolRotation3DFlags in interface IRotationRenderer2pFlags - The pFlags (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getSymbolRotation3DFlags2(int[] pFlagX,
int[] pFlagY,
int[] pFlagZ)
throws IOException,
AutomationException
getSymbolRotation3DFlags2 in interface IRotationRenderer2pFlagX - A com.esri.arcgis.carto.esriSymbolRotation3DFlags constant (out: use single element array)pFlagY - A com.esri.arcgis.carto.esriSymbolRotation3DFlags constant (out: use single element array)pFlagZ - A com.esri.arcgis.carto.esriSymbolRotation3DFlags constant (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSymbolRotation3DFlags2(int flagX,
int flagY,
int flagZ)
throws IOException,
AutomationException
setSymbolRotation3DFlags2 in interface IRotationRenderer2flagX - A com.esri.arcgis.carto.esriSymbolRotation3DFlags constant (in)flagY - A com.esri.arcgis.carto.esriSymbolRotation3DFlags constant (in)flagZ - A com.esri.arcgis.carto.esriSymbolRotation3DFlags constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getSymbolRotation3DRotationTypeZ()
throws IOException,
AutomationException
getSymbolRotation3DRotationTypeZ in interface IRotationRenderer2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSymbolRotation3DRotationTypeZ(int pType)
throws IOException,
AutomationException
setSymbolRotation3DRotationTypeZ in interface IRotationRenderer2pType - A com.esri.arcgis.carto.esriSymbolRotationType constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getSymbolRotation3DExpressions(String[] pExpressionX,
String[] pExpressionY,
String[] pExpressionZ)
throws IOException,
AutomationException
getSymbolRotation3DExpressions in interface IRotationRenderer2pExpressionX - The pExpressionX (out: use single element array)pExpressionY - The pExpressionY (out: use single element array)pExpressionZ - The pExpressionZ (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSymbolRotation3DExpressions(String expressionX,
String expressionY,
String expressionZ)
throws IOException,
AutomationException
setSymbolRotation3DExpressions in interface IRotationRenderer2expressionX - The expressionX (in)expressionY - The expressionY (in)expressionZ - The expressionZ (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getSymbolRotation3DRandomRanges(double[] pMinRotationX,
double[] pMinRotationY,
double[] pMinRotationZ,
double[] pMaxRotationX,
double[] pMaxRotationY,
double[] pMaxRotationZ)
throws IOException,
AutomationException
getSymbolRotation3DRandomRanges in interface IRotationRenderer2pMinRotationX - The pMinRotationX (out: use single element array)pMinRotationY - The pMinRotationY (out: use single element array)pMinRotationZ - The pMinRotationZ (out: use single element array)pMaxRotationX - The pMaxRotationX (out: use single element array)pMaxRotationY - The pMaxRotationY (out: use single element array)pMaxRotationZ - The pMaxRotationZ (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSymbolRotation3DRandomRanges(double minRotationX,
double minRotationY,
double minRotationZ,
double maxRotationX,
double maxRotationY,
double maxRotationZ)
throws IOException,
AutomationException
setSymbolRotation3DRandomRanges in interface IRotationRenderer2minRotationX - The minRotationX (in)minRotationY - The minRotationY (in)minRotationZ - The minRotationZ (in)maxRotationX - The maxRotationX (in)maxRotationY - The maxRotationY (in)maxRotationZ - The maxRotationZ (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getNormalizationField()
throws IOException,
AutomationException
getNormalizationField in interface IDataNormalizationIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setNormalizationField(String fieldName)
throws IOException,
AutomationException
setNormalizationField in interface IDataNormalizationfieldName - The fieldName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getNormalizationFieldAlias()
throws IOException,
AutomationException
NormalizationField alias is not implemented by many of the classes implementing IDataNormalization and will return E_NOTIMPL in those cases.
getNormalizationFieldAlias in interface IDataNormalizationIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setNormalizationFieldAlias(String name)
throws IOException,
AutomationException
setNormalizationFieldAlias in interface IDataNormalizationname - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getNormalizationType()
throws IOException,
AutomationException
esriNormalizeByField requires that the NormalizationField be set.
esriNormalizeByLog takes a base 10 logarithm of the data values.
esriNormalizeByPercentageOfTotal requires the NormalizationTotal field to be set to the total data value. This is used to calculate percentages. Each value is divided by the NormalizationTotal and then multiplied by 100. You can use IDataStatistics to generate NormalizationTotal .
esriNormalizeByArea is not implemented.
esriNormalizeByNothing disables normalization.
getNormalizationType in interface IDataNormalizationIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setNormalizationType(int type)
throws IOException,
AutomationException
setNormalizationType in interface IDataNormalizationtype - A com.esri.arcgis.carto.esriDataNormalization constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getNormalizationTotal()
throws IOException,
AutomationException
Not implemented by ProportionalSymbolRenderer .
getNormalizationTotal in interface IDataNormalizationIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setNormalizationTotal(double value)
throws IOException,
AutomationException
Not implemented by ProportionalSymbolRenderer.
setNormalizationTotal in interface IDataNormalizationvalue - The value (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getWeight()
throws IOException,
AutomationException
A Long value corresponding to a weight in esriBasicOverposterWeight.
getWeight in interface IBarrierProperties2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setWeight(int weight)
throws IOException,
AutomationException
setWeight in interface IBarrierProperties2weight - The weight (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void queryBarriers(IDisplay display,
IGeometryCollection pBarriers,
IEnvelope extent,
ITrackCancel trackCancel)
throws IOException,
AutomationException
queryBarriers in interface IBarrierProperties2display - 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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setExportInfoByRef(IFeatureExportInfoGenerator rhs1)
throws IOException,
AutomationException
setExportInfoByRef in interface IExportSupportrhs1 - A reference to a com.esri.arcgis.carto.IFeatureExportInfoGenerator (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void writeExternal(ObjectOutput out)
throws IOException
writeExternal in interface ExternalizableIOException
public void readExternal(ObjectInput in)
throws IOException,
ClassNotFoundException
readExternal in interface ExternalizableIOException
ClassNotFoundException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||