com.esri.arcgis.carto
Interface ISeriesProperties

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AreaSeriesProperties, BarSeriesProperties, BoxPlotSeriesProperties, FunctionSeriesProperties, HistogramSeriesProperties, ISeriesPropertiesProxy, LineSeriesProperties, PieSeriesProperties, PointSeriesProperties, ScatterPlotMatrixSeriesProperties

public interface ISeriesProperties
extends java.io.Serializable

COM Interface 'ISeriesProperties'. Generated 3/19/2015 1:20:54 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that control graph series.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDae695391_d0ae_4b5e_a9e7_419e091060d2
static int	xxDummy Deprecated. Internal use only

Method Summary

int	getColor(int oID) Color used when ColorType of series property is esriGraphColorCustomEach.
java.lang.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.
java.lang.String	getField(int idx) Gets data field name in the series.
int	getHorizontalAxis() Index of horizontal axis.
java.lang.String	getLabelField() Provides field to be the data source of labels in the graph.
int	getMaxField() Maximum possible fields for the series.
java.lang.String	getName() Name of the series shown in the legend.
IDataGraphTPenProperties	getPenProperties() Interface for drawing lines and borders in the series.
java.lang.Object	getSourceData() Data source for the series.
java.lang.String	getType() Type of the series.
java.lang.String	getUniqueName() Default and unique name of the series.
java.lang.String	getValueFormat() Format string for series value labels.
int	getVerticalAxis() Index of vertical axis
java.lang.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(java.lang.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, java.lang.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(java.lang.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(java.lang.String name) Name of the series shown in the legend.
void	setSourceData(java.lang.Object pVar) Data source for the series.
void	setValueFormat(java.lang.String format) Format string for series value labels.
void	setVerticalAxis(int pIdx) Index of vertical axis
void	setWhereClause(java.lang.String definition) The where clause for querying data source.

Field Detail

IIDae695391_d0ae_4b5e_a9e7_419e091060d2

static final int IIDae695391_d0ae_4b5e_a9e7_419e091060d2

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

isChanged

boolean isChanged()
                  throws java.io.IOException,
                         AutomationException

Indicates if series has changed.

Returns:

The b

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReady

boolean isReady()
                throws java.io.IOException,
                       AutomationException

Indicates if series is ready to work with.

Returns:

The b

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Name of the series shown in the legend.

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

Name of the series shown in the legend.

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUniqueName

java.lang.String getUniqueName()
                               throws java.io.IOException,
                                      AutomationException

Default and unique name of the series.

Returns:

The uname

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

java.lang.String getType()
                         throws java.io.IOException,
                                AutomationException

Type of the series.

Returns:

The typeName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceData

void setSourceData(java.lang.Object pVar)
                   throws java.io.IOException,
                          AutomationException

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

Parameters:

pVar - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceData

java.lang.Object getSourceData()
                               throws java.io.IOException,
                                      AutomationException

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

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWhereClause

java.lang.String getWhereClause()
                                throws java.io.IOException,
                                       AutomationException

The where clause for querying data source.

Returns:

The definition

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWhereClause

void setWhereClause(java.lang.String definition)
                    throws java.io.IOException,
                           AutomationException

The where clause for querying data source.

Parameters:

definition - The definition (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelField

java.lang.String getLabelField()
                               throws java.io.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.

Returns:

The pFieldName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelField

void setLabelField(java.lang.String pFieldName)
                   throws java.io.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.

Parameters:

pFieldName - The pFieldName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxField

int getMaxField()
                throws java.io.IOException,
                       AutomationException

Maximum possible fields for the series.

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setField

void setField(int idx,
              java.lang.String fieldName)
              throws java.io.IOException,
                     AutomationException

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

Parameters:

idx - The idx (in)

fieldName - The fieldName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getField

java.lang.String getField(int idx)
                          throws java.io.IOException,
                                 AutomationException

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

Parameters:

idx - The idx (in)

Returns:

The fieldName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFieldOptional

boolean isFieldOptional(int idx)
                        throws java.io.IOException,
                               AutomationException

Indicates if data field is optional.

Parameters:

idx - The idx (in)

Returns:

The bOptional

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColorType

int getColorType()
                 throws java.io.IOException,
                        AutomationException

Type of color applied to the graph series.

Returns:

A com.esri.arcgis.carto.esriGraphColorType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColorType

void setColorType(int eColorType)
                  throws java.io.IOException,
                         AutomationException

Type of color applied to the graph series.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomColor

int getCustomColor()
                   throws java.io.IOException,
                          AutomationException

Color used when ColorType of series property is esriGraphColorCustomAll.

Returns:

The pColor (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomColor

void setCustomColor(int pColor)
                    throws java.io.IOException,
                           AutomationException

Color used when ColorType of series property is esriGraphColorCustomAll.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColor

int getColor(int oID)
             throws java.io.IOException,
                    AutomationException

Color used when ColorType of series property is esriGraphColorCustomEach.

Parameters:

oID - The oID (in)

Returns:

The pColor (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColor

void setColor(int oID,
              int pColor)
              throws java.io.IOException,
                     AutomationException

Color used when ColorType of series property is esriGraphColorCustomEach.

Parameters:

oID - The oID (in)

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColorPalette

java.lang.String getColorPalette()
                                 throws java.io.IOException,
                                        AutomationException

Palette used when ColorType of series property is esriGraphColorPalette.

Returns:

The paletteName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColorPalette

void setColorPalette(java.lang.String paletteName)
                     throws java.io.IOException,
                            AutomationException

Palette used when ColorType of series property is esriGraphColorPalette.

Parameters:

paletteName - The paletteName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInLegend

boolean isInLegend()
                   throws java.io.IOException,
                          AutomationException

Indicates if series is added to the graph legend.

Returns:

The b

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInLegend

void setInLegend(boolean b)
                 throws java.io.IOException,
                        AutomationException

Indicates if series is added to the graph legend.

Parameters:

b - The b (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMarks

boolean isMarks()
                throws java.io.IOException,
                       AutomationException

Indicates if series shows marks.

Returns:

The b

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMarks

void setMarks(boolean b)
              throws java.io.IOException,
                     AutomationException

Indicates if series shows marks.

Parameters:

b - The b (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPenProperties

IDataGraphTPenProperties getPenProperties()
                                          throws java.io.IOException,
                                                 AutomationException

Interface for drawing lines and borders in the series.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValueFormat

java.lang.String getValueFormat()
                                throws java.io.IOException,
                                       AutomationException

Format string for series value labels.

Returns:

The format

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setValueFormat

void setValueFormat(java.lang.String format)
                    throws java.io.IOException,
                           AutomationException

Format string for series value labels.

Parameters:

format - The format (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHorizontalAxis

int getHorizontalAxis()
                      throws java.io.IOException,
                             AutomationException

Index of horizontal axis.

Returns:

The pIdx

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHorizontalAxis

void setHorizontalAxis(int pIdx)
                       throws java.io.IOException,
                              AutomationException

Index of horizontal axis.

Parameters:

pIdx - The pIdx (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVerticalAxis

int getVerticalAxis()
                    throws java.io.IOException,
                           AutomationException

Index of vertical axis

Returns:

The pIdx

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVerticalAxis

void setVerticalAxis(int pIdx)
                     throws java.io.IOException,
                            AutomationException

Index of vertical axis

Parameters:

pIdx - The pIdx (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.