Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.carto
Interface ISeriesProperties

All Superinterfaces:
Serializable
All Known Implementing Classes:
AreaSeriesProperties, BarSeriesProperties, BoxPlotSeriesProperties, FunctionSeriesProperties, HistogramSeriesProperties, ISeriesPropertiesProxy, LineSeriesProperties, PieSeriesProperties, PointSeriesProperties, ScatterPlotMatrixSeriesProperties
public interface ISeriesProperties
extends Serializable

Provides access to members that control graph series.

Product Availability

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

Method Summary
 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 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.
 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 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 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.
 

Method Detail

isChanged

boolean isChanged()
                  throws IOException,
                         AutomationException
Indicates if series has changed.

Product Availability

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

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

isReady

boolean isReady()
                throws IOException,
                       AutomationException
Indicates if series is ready to work with.

Product Availability

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

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

getName

String getName()
               throws IOException,
                      AutomationException
Name of the series shown in the legend.

Product Availability

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

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

setName

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.

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

getUniqueName

String getUniqueName()
                     throws IOException,
                            AutomationException
Default and unique name of the series.

Product Availability

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

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

getType

String getType()
               throws IOException,
                      AutomationException
Type of the series.

Product Availability

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

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

setSourceData

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.

Parameters:
pVar - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSourceData

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.

Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWhereClause

String getWhereClause()
                      throws IOException,
                             AutomationException
The where clause for querying data source.

Product Availability

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

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

setWhereClause

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.

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

getLabelField

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.

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

setLabelField

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.

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

getMaxField

int getMaxField()
                throws IOException,
                       AutomationException
Maximum possible fields for the series.

Product Availability

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

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

setField

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.

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

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.

Parameters:
idx - The idx (in)
Returns:
The fieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isFieldOptional

boolean isFieldOptional(int idx)
                        throws IOException,
                               AutomationException
Indicates if data field is optional.

Product Availability

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

Parameters:
idx - The idx (in)
Returns:
The bOptional
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColorType

int getColorType()
                 throws IOException,
                        AutomationException
Type of color applied to the graph series.

Product Availability

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

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

setColorType

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.

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

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.

Returns:
The pColor (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCustomColor

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.

Parameters:
pColor - The pColor (A COM typedef) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColor

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.

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

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.

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

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.

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

setColorPalette

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.

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

isInLegend

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.

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

setInLegend

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.

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

isMarks

boolean isMarks()
                throws IOException,
                       AutomationException
Indicates if series shows marks.

Product Availability

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

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

setMarks

void setMarks(boolean b)
              throws IOException,
                     AutomationException
Indicates if series shows marks.

Product Availability

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

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

getPenProperties

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.

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

String getValueFormat()
                      throws IOException,
                             AutomationException
Format string for series value labels.

Product Availability

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

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

setValueFormat

void setValueFormat(String format)
                    throws IOException,
                           AutomationException
Format string for series value labels.

Product Availability

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

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

getHorizontalAxis

int getHorizontalAxis()
                      throws IOException,
                             AutomationException
Index of horizontal axis.

Product Availability

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

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

setHorizontalAxis

void setHorizontalAxis(int pIdx)
                       throws IOException,
                              AutomationException
Index of horizontal axis.

Product Availability

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

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

getVerticalAxis

int getVerticalAxis()
                    throws IOException,
                           AutomationException
Index of vertical axis

Product Availability

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

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

setVerticalAxis

void setVerticalAxis(int pIdx)
                     throws IOException,
                            AutomationException
Index of vertical axis

Product Availability

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

Parameters:
pIdx - The pIdx (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD