com.esri.arcgis.carto
Interface IDataGraphT

All Superinterfaces:

IDataGraphBase, Serializable

All Known Implementing Classes:

DataGraphT, DataGraphTScatterPlotMatrix, IDataGraphTProxy

public interface IDataGraphT
extends IDataGraphBase, Serializable

Provides access to members that control data graph.

Product Availability

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

Method Summary

ISeriesProperties	addSeries(String seriesType) Add series from the provided graph type.
void	exportToFileEx(String filename, int width, int height) Exports the data graph to a file.
int	getAxisCount() Amount of axis.
IDataGraphTAxisProperties	getAxisProperties(int idx) Properties of graph axis.
IDataGraphTGeneralProperties	getGeneralProperties() General properties of the graph.
IDataGraphTLegendProperties	getLegendProperties() Properties of graph legend.
int	getSeriesCount() The number of series in the graph.
int	getSeriesOrder(ISeriesProperties pSeriesProps) Position of the series in the series list of the graph.
ISeriesProperties	getSeriesProperties(int iSeries) Series properties for provided series index.
void	identify(int iSeries, int ptX, int ptY, Object[] pOIDs) Identifies object ID for the series using graph coordinates.
boolean	isHighlightSelection() Indicates whether graph handles selection in the input layer by creating series only from the selected data or highlights selected values on the graph made from entire dataset.
void	loadTemplate(String file) Loads graph properties from the template file.
void	removeSeries(ISeriesProperties pSeriesProps) Remove series from the graph.
void	setHighlightSelection(boolean b) Indicates whether graph handles selection in the input layer by creating series only from the selected data or highlights selected values on the graph made from entire dataset.
void	setSeriesOrder(ISeriesProperties pSeriesProps, int pPos) Position of the series in the series list of the graph.
void	update(ITrackCancel pCancel) Updates graph after changes in graph or series properties.

Methods inherited from interface com.esri.arcgis.carto.IDataGraphBase

copyToClipboard, drawToDC, exportToFile, getName, isUseSelectedSet, loadFromFile, reload, saveToFile, setName, setUseSelectedSet

Method Detail

isHighlightSelection

boolean isHighlightSelection()
                             throws IOException,
                                    AutomationException

Indicates whether graph handles selection in the input layer by creating series only from the selected data or highlights selected values on the graph made from entire dataset.

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.

setHighlightSelection

void setHighlightSelection(boolean b)
                           throws IOException,
                                  AutomationException

Indicates whether graph handles selection in the input layer by creating series only from the selected data or highlights selected values on the graph made from entire dataset.

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.

addSeries

ISeriesProperties addSeries(String seriesType)
                            throws IOException,
                                   AutomationException

Add series from the provided graph type.

Product Availability

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

Parameters:

seriesType - The seriesType (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeSeries

void removeSeries(ISeriesProperties pSeriesProps)
                  throws IOException,
                         AutomationException

Remove series from the graph.

Product Availability

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

Parameters:

pSeriesProps - A reference to a com.esri.arcgis.carto.ISeriesProperties (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSeriesCount

int getSeriesCount()
                   throws IOException,
                          AutomationException

The number of series in the graph.

Product Availability

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

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSeriesProperties

ISeriesProperties getSeriesProperties(int iSeries)
                                      throws IOException,
                                             AutomationException

Series properties for provided series index.

Product Availability

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

Parameters:

iSeries - The iSeries (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSeriesOrder

void setSeriesOrder(ISeriesProperties pSeriesProps,
                    int pPos)
                    throws IOException,
                           AutomationException

Position of the series in the series list of the graph.

Product Availability

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

Parameters:

pSeriesProps - A reference to a com.esri.arcgis.carto.ISeriesProperties (in)

pPos - The pPos (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSeriesOrder

int getSeriesOrder(ISeriesProperties pSeriesProps)
                   throws IOException,
                          AutomationException

Position of the series in the series list of the graph.

Product Availability

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

Parameters:

pSeriesProps - A reference to a com.esri.arcgis.carto.ISeriesProperties (in)

Returns:

The pPos

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeneralProperties

IDataGraphTGeneralProperties getGeneralProperties()
                                                  throws IOException,
                                                         AutomationException

General properties of the graph.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendProperties

IDataGraphTLegendProperties getLegendProperties()
                                                throws IOException,
                                                       AutomationException

Properties of graph legend.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAxisCount

int getAxisCount()
                 throws IOException,
                        AutomationException

Amount of axis.

Product Availability

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

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAxisProperties

IDataGraphTAxisProperties getAxisProperties(int idx)
                                            throws IOException,
                                                   AutomationException

Properties of graph axis.

Product Availability

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

Parameters:

idx - The idx (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

identify

void identify(int iSeries,
              int ptX,
              int ptY,
              Object[] pOIDs)
              throws IOException,
                     AutomationException

Identifies object ID for the series using graph coordinates.

Product Availability

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

Parameters:

iSeries - The iSeries (in)

ptX - The ptX (in)

ptY - The ptY (in)

pOIDs - A Variant (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

update

void update(ITrackCancel pCancel)
            throws IOException,
                   AutomationException

Updates graph after changes in graph or series properties.

Product Availability

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

Parameters:

pCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadTemplate

void loadTemplate(String file)
                  throws IOException,
                         AutomationException

Loads graph properties from the template file.

Product Availability

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

Parameters:

file - The file (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportToFileEx

void exportToFileEx(String filename,
                    int width,
                    int height)
                    throws IOException,
                           AutomationException

Exports the data graph to a file.

Product Availability

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

Parameters:

filename - The filename (in)

width - The width (in)

height - The height (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.