|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.cartoUI.PieSeriesProperties
public class PieSeriesProperties
A container for the display and manipulation of pie graph series.
Constructor Summary | |
---|---|
PieSeriesProperties(Object obj)
Construct a PieSeriesProperties using a reference to such an object returned from ArcGIS Engine or Server. |
Method Summary | |
---|---|
void |
addSortingField(String strField,
boolean bAscending,
int[] idx)
Add a sorting field and type. |
void |
definitionExpressionChanged(IDefinitionExpressionEventsDefinitionExpressionChangedEvent theEvent)
Occurs when the Definition Expression changes. |
boolean |
equals(Object o)
Compare this object with another |
void |
featureLayerSelectionChanged(IFeatureLayerSelectionEventsFeatureLayerSelectionChangedEvent theEvent)
Occurs when the selection changes. |
int |
getColor(int oID)
Color used when ColorType of series property is esriGraphColorCustomEach. |
String |
getColorPalette()
Palette used when ColorType of series property is esriGraphColorPalette. |
int |
getColorType()
Type of color applied to the graph series. |
int |
getCustomColor()
Color used when ColorType of series property is esriGraphColorCustomAll. |
int |
getExplodeBiggestSlice()
The percentage of extrusion for the biggest slice. |
String |
getField(int idx)
Gets data field name in the series. |
int |
getHorizontalAxis()
Index of horizontal axis. |
String |
getLabelField()
Provides field to be the data source of labels in the graph. |
int |
getMaxField()
Maximum possible fields for the series. |
String |
getName()
Name of the series shown in the legend. |
IDataGraphTPenProperties |
getPenProperties()
Interface for drawing lines and borders in the series. |
int |
getRotatePie()
The degree in rotating the pie. |
void |
getSortingField(int idx,
String[] strField,
boolean[] bAscending)
Get a sorting field and type. |
int |
getSortingFieldsCount()
Number of sorting fields. |
Object |
getSourceData()
Data source for the series. |
int |
getTotalPieAngle()
The angle of the entire pie display. |
String |
getType()
Type of the series. |
String |
getUniqueName()
Default and unique name of the series. |
String |
getValueFormat()
Format string for series value labels. |
int |
getVerticalAxis()
Index of vertical axis |
String |
getWhereClause()
The where clause for querying data source. |
int |
hashCode()
the hashcode for this object |
boolean |
isChanged()
Indicates if series has changed. |
boolean |
isFieldOptional(int idx)
Indicates if data field is optional. |
boolean |
isInLegend()
Indicates if series is added to the graph legend. |
boolean |
isMarks()
Indicates if series shows marks. |
boolean |
isReady()
Indicates if series is ready to work with. |
void |
removeSortingField(int idx)
Remove the sorting field. |
void |
selectionChanged(ISelectionEventsSelectionChangedEvent theEvent)
Call this function to fire the selection changed event. |
void |
setColor(int oID,
int pColor)
Color used when ColorType of series property is esriGraphColorCustomEach. |
void |
setColorPalette(String paletteName)
Palette used when ColorType of series property is esriGraphColorPalette. |
void |
setColorType(int eColorType)
Type of color applied to the graph series. |
void |
setCustomColor(int pColor)
Color used when ColorType of series property is esriGraphColorCustomAll. |
void |
setExplodeBiggestSlice(int amount)
The percentage of extrusion for the biggest slice. |
void |
setField(int idx,
String fieldName)
Sets data field name in the series. |
void |
setHorizontalAxis(int pIdx)
Index of horizontal axis. |
void |
setInLegend(boolean b)
Indicates if series is added to the graph legend. |
void |
setLabelField(String pFieldName)
Provides field to be the data source of labels in the graph. |
void |
setMarks(boolean b)
Indicates if series shows marks. |
void |
setName(String name)
Name of the series shown in the legend. |
void |
setRotatePie(int degree)
The degree in rotating the pie. |
void |
setSourceData(Object pVar)
Data source for the series. |
void |
setTotalPieAngle(int degree)
The angle of the entire pie display. |
void |
setValueFormat(String format)
Format string for series value labels. |
void |
setVerticalAxis(int pIdx)
Index of vertical axis |
void |
setWhereClause(String definition)
The where clause for querying data source. |
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 PieSeriesProperties(Object obj) throws IOException
obj
to PieSeriesProperties
. *
PieSeriesProperties o = (PieSeriesProperties)obj; // will not work
PieSeriesProperties o = new PieSeriesProperties(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server
IOException
- if there are interop problems
PieSeriesProperties thePieSeriesProperties = (PieSeriesProperties) obj;
Method Detail |
---|
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public boolean isChanged() throws IOException, AutomationException
isChanged
in interface ISeriesProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isReady() throws IOException, AutomationException
isReady
in interface ISeriesProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getName() throws IOException, AutomationException
getName
in interface ISeriesProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setName(String name) throws IOException, AutomationException
setName
in interface ISeriesProperties
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getUniqueName() throws IOException, AutomationException
getUniqueName
in interface ISeriesProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getType() throws IOException, AutomationException
getType
in interface ISeriesProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSourceData(Object pVar) throws IOException, AutomationException
setSourceData
in interface ISeriesProperties
pVar
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getSourceData() throws IOException, AutomationException
getSourceData
in interface ISeriesProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getWhereClause() throws IOException, AutomationException
getWhereClause
in interface ISeriesProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setWhereClause(String definition) throws IOException, AutomationException
setWhereClause
in interface ISeriesProperties
definition
- The definition (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getLabelField() throws IOException, AutomationException
getLabelField
in interface ISeriesProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setLabelField(String pFieldName) throws IOException, AutomationException
setLabelField
in interface ISeriesProperties
pFieldName
- The pFieldName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getMaxField() throws IOException, AutomationException
getMaxField
in interface ISeriesProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setField(int idx, String fieldName) throws IOException, AutomationException
setField
in interface ISeriesProperties
idx
- The idx (in)fieldName
- The fieldName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getField(int idx) throws IOException, AutomationException
getField
in interface ISeriesProperties
idx
- The idx (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isFieldOptional(int idx) throws IOException, AutomationException
isFieldOptional
in interface ISeriesProperties
idx
- The idx (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getColorType() throws IOException, AutomationException
getColorType
in interface ISeriesProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setColorType(int eColorType) throws IOException, AutomationException
setColorType
in interface ISeriesProperties
eColorType
- A com.esri.arcgis.carto.esriGraphColorType constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getCustomColor() throws IOException, AutomationException
getCustomColor
in interface ISeriesProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCustomColor(int pColor) throws IOException, AutomationException
setCustomColor
in interface ISeriesProperties
pColor
- The pColor (A COM typedef) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getColor(int oID) throws IOException, AutomationException
getColor
in interface ISeriesProperties
oID
- The oID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setColor(int oID, int pColor) throws IOException, AutomationException
setColor
in interface ISeriesProperties
oID
- The oID (in)pColor
- The pColor (A COM typedef) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getColorPalette() throws IOException, AutomationException
getColorPalette
in interface ISeriesProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setColorPalette(String paletteName) throws IOException, AutomationException
setColorPalette
in interface ISeriesProperties
paletteName
- The paletteName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isInLegend() throws IOException, AutomationException
isInLegend
in interface ISeriesProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setInLegend(boolean b) throws IOException, AutomationException
setInLegend
in interface ISeriesProperties
b
- The b (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isMarks() throws IOException, AutomationException
isMarks
in interface ISeriesProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMarks(boolean b) throws IOException, AutomationException
setMarks
in interface ISeriesProperties
b
- The b (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IDataGraphTPenProperties getPenProperties() throws IOException, AutomationException
getPenProperties
in interface ISeriesProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getValueFormat() throws IOException, AutomationException
getValueFormat
in interface ISeriesProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setValueFormat(String format) throws IOException, AutomationException
setValueFormat
in interface ISeriesProperties
format
- The format (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getHorizontalAxis() throws IOException, AutomationException
getHorizontalAxis
in interface ISeriesProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setHorizontalAxis(int pIdx) throws IOException, AutomationException
setHorizontalAxis
in interface ISeriesProperties
pIdx
- The pIdx (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getVerticalAxis() throws IOException, AutomationException
getVerticalAxis
in interface ISeriesProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setVerticalAxis(int pIdx) throws IOException, AutomationException
setVerticalAxis
in interface ISeriesProperties
pIdx
- The pIdx (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getExplodeBiggestSlice() throws IOException, AutomationException
getExplodeBiggestSlice
in interface IPieSeriesProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setExplodeBiggestSlice(int amount) throws IOException, AutomationException
setExplodeBiggestSlice
in interface IPieSeriesProperties
amount
- The amount (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getTotalPieAngle() throws IOException, AutomationException
getTotalPieAngle
in interface IPieSeriesProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTotalPieAngle(int degree) throws IOException, AutomationException
setTotalPieAngle
in interface IPieSeriesProperties
degree
- The degree (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getRotatePie() throws IOException, AutomationException
getRotatePie
in interface IPieSeriesProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setRotatePie(int degree) throws IOException, AutomationException
setRotatePie
in interface IPieSeriesProperties
degree
- The degree (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void addSortingField(String strField, boolean bAscending, int[] idx) throws IOException, AutomationException
addSortingField
in interface IDataSortSeriesProperties
strField
- The strField (in)bAscending
- The bAscending (in)idx
- The idx (in/out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getSortingField(int idx, String[] strField, boolean[] bAscending) throws IOException, AutomationException
getSortingField
in interface IDataSortSeriesProperties
idx
- The idx (in)strField
- The strField (out: use single element array)bAscending
- The bAscending (in/out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void removeSortingField(int idx) throws IOException, AutomationException
removeSortingField
in interface IDataSortSeriesProperties
idx
- The idx (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getSortingFieldsCount() throws IOException, AutomationException
getSortingFieldsCount
in interface IDataSortSeriesProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void featureLayerSelectionChanged(IFeatureLayerSelectionEventsFeatureLayerSelectionChangedEvent theEvent) throws IOException, AutomationException
featureLayerSelectionChanged
in interface IFeatureLayerSelectionEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void selectionChanged(ISelectionEventsSelectionChangedEvent theEvent) throws IOException, AutomationException
selectionChanged
in interface ISelectionEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void definitionExpressionChanged(IDefinitionExpressionEventsDefinitionExpressionChangedEvent theEvent) throws IOException, AutomationException
definitionExpressionChanged
in interface IDefinitionExpressionEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |