com.esri.arcgis.cartoUI
Class FunctionSeriesProperties

java.lang.Object
  com.esri.arcgis.cartoUI.FunctionSeriesProperties

All Implemented Interfaces:

IDefinitionExpressionEvents, IFeatureLayerSelectionEvents, IFunctionSeriesProperties, ISelectionEvents, ISeriesProperties, com.esri.arcgis.interop.RemoteObjRef, Serializable, EventListener

public class FunctionSeriesProperties
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISeriesProperties, IFunctionSeriesProperties, IFeatureLayerSelectionEvents, ISelectionEvents, IDefinitionExpressionEvents

A container for the display and manipulation of function graph series.

Product Availability

Available with ArcGIS Desktop.

See Also:

Serialized Form

Constructor Summary

FunctionSeriesProperties(Object obj)
Construct a FunctionSeriesProperties using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	changeFunctionType(String newType) Changes function to the one with type name provided.
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.
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.
Object	getProperty(String name) Value of the property with the provided name.
Object	getSourceData() Data source for the series.
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	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	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	setProperty(String name, Object pVal) Value of the property with the provided name.
void	setSourceData(Object pVar) Data source for the series.
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

FunctionSeriesProperties

public FunctionSeriesProperties(Object obj)
                         throws IOException

Construct a FunctionSeriesProperties using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to FunctionSeriesProperties.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
FunctionSeriesProperties o = (FunctionSeriesProperties)obj; // will not work

FunctionSeriesProperties o = new FunctionSeriesProperties(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems FunctionSeriesProperties theFunctionSeriesProperties = (FunctionSeriesProperties) obj;

Method Detail

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

isChanged

public boolean isChanged()
                  throws IOException,
                         AutomationException

Indicates if series has changed.

Product Availability

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

Specified by:

isChanged in interface ISeriesProperties

Returns:

The b

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReady

public boolean isReady()
                throws IOException,
                       AutomationException

Indicates if series is ready to work with.

Product Availability

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

Specified by:

isReady in interface ISeriesProperties

Returns:

The b

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the series shown in the legend.

Product Availability

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

Specified by:

getName in interface ISeriesProperties

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException

Name of the series shown in the legend.

Product Availability

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

Specified by:

setName in interface ISeriesProperties

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUniqueName

public String getUniqueName()
                     throws IOException,
                            AutomationException

Default and unique name of the series.

Product Availability

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

Specified by:

getUniqueName in interface ISeriesProperties

Returns:

The uname

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

public String getType()
               throws IOException,
                      AutomationException

Type of the series.

Product Availability

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

Specified by:

getType in interface ISeriesProperties

Returns:

The typeName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceData

public void setSourceData(Object pVar)
                   throws IOException,
                          AutomationException

Data source for the series. Can be table, feature, raster layer, or name of another series for function series.

Product Availability

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

Specified by:

setSourceData in interface ISeriesProperties

Parameters:

pVar - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceData

public Object getSourceData()
                     throws IOException,
                            AutomationException

Data source for the series. Can be table, feature, raster layer, or name of another series for function series.

Product Availability

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

Specified by:

getSourceData in interface ISeriesProperties

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWhereClause

public String getWhereClause()
                      throws IOException,
                             AutomationException

The where clause for querying data source.

Product Availability

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

Specified by:

getWhereClause in interface ISeriesProperties

Returns:

The definition

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWhereClause

public void setWhereClause(String definition)
                    throws IOException,
                           AutomationException

The where clause for querying data source.

Product Availability

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

Specified by:

setWhereClause in interface ISeriesProperties

Parameters:

definition - The definition (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelField

public String getLabelField()
                     throws IOException,
                            AutomationException

Provides field to be the data source of labels in the graph. Only the field from the first series will be used in the graph if there are more than one series.

Product Availability

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

Specified by:

getLabelField in interface ISeriesProperties

Returns:

The pFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelField

public void setLabelField(String pFieldName)
                   throws IOException,
                          AutomationException

Provides field to be the data source of labels in the graph. Only the field from the first series will be used in the graph if there are more than one series.

Product Availability

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

Specified by:

setLabelField in interface ISeriesProperties

Parameters:

pFieldName - The pFieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxField

public int getMaxField()
                throws IOException,
                       AutomationException

Maximum possible fields for the series.

Product Availability

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

Specified by:

getMaxField in interface ISeriesProperties

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setField

public void setField(int idx,
                     String fieldName)
              throws IOException,
                     AutomationException

Sets data field name in the series. Can be multiple and optional depending on series type.

Product Availability

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

Specified by:

setField in interface ISeriesProperties

Parameters:

idx - The idx (in)

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getField

public String getField(int idx)
                throws IOException,
                       AutomationException

Gets data field name in the series. Can be multiple and optional depending on series type.

Product Availability

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

Specified by:

getField in interface ISeriesProperties

Parameters:

idx - The idx (in)

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFieldOptional

public boolean isFieldOptional(int idx)
                        throws IOException,
                               AutomationException

Indicates if data field is optional.

Product Availability

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

Specified by:

isFieldOptional in interface ISeriesProperties

Parameters:

idx - The idx (in)

Returns:

The bOptional

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColorType

public int getColorType()
                 throws IOException,
                        AutomationException

Type of color applied to the graph series.

Product Availability

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

Specified by:

getColorType in interface ISeriesProperties

Returns:

A com.esri.arcgis.carto.esriGraphColorType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColorType

public void setColorType(int eColorType)
                  throws IOException,
                         AutomationException

Type of color applied to the graph series.

Product Availability

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

Specified by:

setColorType in interface ISeriesProperties

Parameters:

eColorType - A com.esri.arcgis.carto.esriGraphColorType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomColor

public int getCustomColor()
                   throws IOException,
                          AutomationException

Color used when ColorType of series property is esriGraphColorCustomAll.

Product Availability

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

Specified by:

getCustomColor in interface ISeriesProperties

Returns:

The pColor (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomColor

public void setCustomColor(int pColor)
                    throws IOException,
                           AutomationException

Color used when ColorType of series property is esriGraphColorCustomAll.

Product Availability

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

Specified by:

setCustomColor in interface ISeriesProperties

Parameters:

pColor - The pColor (A COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColor

public int getColor(int oID)
             throws IOException,
                    AutomationException

Color used when ColorType of series property is esriGraphColorCustomEach.

Product Availability

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

Specified by:

getColor in interface ISeriesProperties

Parameters:

oID - The oID (in)

Returns:

The pColor (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColor

public void setColor(int oID,
                     int pColor)
              throws IOException,
                     AutomationException

Color used when ColorType of series property is esriGraphColorCustomEach.

Product Availability

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

Specified by:

setColor in interface ISeriesProperties

Parameters:

oID - The oID (in)

pColor - The pColor (A COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColorPalette

public String getColorPalette()
                       throws IOException,
                              AutomationException

Palette used when ColorType of series property is esriGraphColorPalette.

Product Availability

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

Specified by:

getColorPalette in interface ISeriesProperties

Returns:

The paletteName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColorPalette

public void setColorPalette(String paletteName)
                     throws IOException,
                            AutomationException

Palette used when ColorType of series property is esriGraphColorPalette.

Product Availability

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

Specified by:

setColorPalette in interface ISeriesProperties

Parameters:

paletteName - The paletteName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInLegend

public boolean isInLegend()
                   throws IOException,
                          AutomationException

Indicates if series is added to the graph legend.

Product Availability

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

Specified by:

isInLegend in interface ISeriesProperties

Returns:

The b

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInLegend

public void setInLegend(boolean b)
                 throws IOException,
                        AutomationException

Indicates if series is added to the graph legend.

Product Availability

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

Specified by:

setInLegend in interface ISeriesProperties

Parameters:

b - The b (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMarks

public boolean isMarks()
                throws IOException,
                       AutomationException

Indicates if series shows marks.

Product Availability

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

Specified by:

isMarks in interface ISeriesProperties

Returns:

The b

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMarks

public void setMarks(boolean b)
              throws IOException,
                     AutomationException

Indicates if series shows marks.

Product Availability

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

Specified by:

setMarks in interface ISeriesProperties

Parameters:

b - The b (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPenProperties

public IDataGraphTPenProperties getPenProperties()
                                          throws IOException,
                                                 AutomationException

Interface for drawing lines and borders in the series.

Product Availability

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

Specified by:

getPenProperties in interface ISeriesProperties

Returns:

A reference to a com.esri.arcgis.carto.IDataGraphTPenProperties

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValueFormat

public String getValueFormat()
                      throws IOException,
                             AutomationException

Format string for series value labels.

Product Availability

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

Specified by:

getValueFormat in interface ISeriesProperties

Returns:

The format

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setValueFormat

public void setValueFormat(String format)
                    throws IOException,
                           AutomationException

Format string for series value labels.

Product Availability

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

Specified by:

setValueFormat in interface ISeriesProperties

Parameters:

format - The format (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHorizontalAxis

public int getHorizontalAxis()
                      throws IOException,
                             AutomationException

Index of horizontal axis.

Product Availability

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

Specified by:

getHorizontalAxis in interface ISeriesProperties

Returns:

The pIdx

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHorizontalAxis

public void setHorizontalAxis(int pIdx)
                       throws IOException,
                              AutomationException

Index of horizontal axis.

Product Availability

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

Specified by:

setHorizontalAxis in interface ISeriesProperties

Parameters:

pIdx - The pIdx (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVerticalAxis

public int getVerticalAxis()
                    throws IOException,
                           AutomationException

Index of vertical axis

Product Availability

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

Specified by:

getVerticalAxis in interface ISeriesProperties

Returns:

The pIdx

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVerticalAxis

public void setVerticalAxis(int pIdx)
                     throws IOException,
                            AutomationException

Index of vertical axis

Product Availability

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

Specified by:

setVerticalAxis in interface ISeriesProperties

Parameters:

pIdx - The pIdx (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

changeFunctionType

public void changeFunctionType(String newType)
                        throws IOException,
                               AutomationException

Changes function to the one with type name provided.

Product Availability

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

Specified by:

changeFunctionType in interface IFunctionSeriesProperties

Parameters:

newType - The newType (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProperty

public void setProperty(String name,
                        Object pVal)
                 throws IOException,
                        AutomationException

Value of the property with the provided name. Not applicable to all functions.

Product Availability

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

Specified by:

setProperty in interface IFunctionSeriesProperties

Parameters:

name - The name (in)

pVal - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProperty

public Object getProperty(String name)
                   throws IOException,
                          AutomationException

Value of the property with the provided name. Not applicable to all functions.

Product Availability

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

Specified by:

getProperty in interface IFunctionSeriesProperties

Parameters:

name - The name (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

featureLayerSelectionChanged

public void featureLayerSelectionChanged(IFeatureLayerSelectionEventsFeatureLayerSelectionChangedEvent theEvent)
                                  throws IOException,
                                         AutomationException

Occurs when the selection changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

featureLayerSelectionChanged in interface IFeatureLayerSelectionEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

selectionChanged

public void selectionChanged(ISelectionEventsSelectionChangedEvent theEvent)
                      throws IOException,
                             AutomationException

Call this function to fire the selection changed event.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

selectionChanged in interface ISelectionEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

definitionExpressionChanged

public void definitionExpressionChanged(IDefinitionExpressionEventsDefinitionExpressionChangedEvent theEvent)
                                 throws IOException,
                                        AutomationException

Occurs when the Definition Expression changes.

Product Availability

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

Specified by:

definitionExpressionChanged in interface IDefinitionExpressionEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.