com.esri.arcgis.carto
Class IDataGraphBaseProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.carto.IDataGraphBaseProxy

All Implemented Interfaces:

IDataGraphBase, Externalizable, Serializable

Direct Known Subclasses:

IDataGraphTProxy

public class IDataGraphBaseProxy
extends com.esri.arcgis.interop.Dispatch
implements IDataGraphBase, Serializable

Provides access to members that control the data graph.

Remarks

The IDataGraphBase interface is a common interface for both DataGraph and DataGraphT CoClasses. It provides access to basic functionality for graph such as copy, draw, export, load, rename, and save. It also handles selection for graph.

Product Availability

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

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IDataGraphBaseProxy()
	IDataGraphBaseProxy(Object obj)
protected	IDataGraphBaseProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	copyToClipboard() Copies the data graph to the clipboard as a metafile.
void	drawToDC(int hDC, tagRECT pOutputRect, tagRECT pGraphRect) Draws the data graph into the provided device context.
void	exportToFile(String filename) Exports the data graph to a file.
String	getName() Name of the data graph.
boolean	isUseSelectedSet() Indicates if the selected set of the series from input dataset is used to build graph.
void	loadFromFile(String filename) Loads the data graph from a .grf file.
void	reload() Reloads data values in data graph series.
void	removeListener(String iidStr, Object theListener)
void	saveToFile(String filename) Saves the data graph to a .grf file.
void	setName(String pName) Name of the data graph.
void	setUseSelectedSet(boolean pUseSel) Indicates if the selected set of the series from input dataset is used to build graph.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IDataGraphBaseProxy

public IDataGraphBaseProxy()

IDataGraphBaseProxy

public IDataGraphBaseProxy(Object obj)
                    throws IOException

Throws:

IOException

IDataGraphBaseProxy

protected IDataGraphBaseProxy(Object obj,
                              String iid)
                       throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the data graph.

Product Availability

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

Specified by:

getName in interface IDataGraphBase

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String pName)
             throws IOException,
                    AutomationException

Name of the data graph.

Product Availability

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

Specified by:

setName in interface IDataGraphBase

Parameters:

pName - The pName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseSelectedSet

public boolean isUseSelectedSet()
                         throws IOException,
                                AutomationException

Indicates if the selected set of the series from input dataset is used to build graph.

Remarks

Value is the only parameter. Graphs can be built based on selected set from the input data. There are two methods available: HighlightSelection (from IDataGraphT) and UseSelectedSet (from IDataGraphBase). If UseSelectedSet is set to true, graph series will be built based on selection. There are two modes on how graph is drawn. The first one is by highlighting features on the graph (HighlightSelection is set to true in this case), and the second one is building graph from selected features only (HighlighteSelection is set to false in this case).

Product Availability

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

Specified by:

isUseSelectedSet in interface IDataGraphBase

Returns:

The pUseSel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseSelectedSet

public void setUseSelectedSet(boolean pUseSel)
                       throws IOException,
                              AutomationException

Indicates if the selected set of the series from input dataset is used to build graph.

Product Availability

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

Specified by:

setUseSelectedSet in interface IDataGraphBase

Parameters:

pUseSel - The pUseSel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reload

public void reload()
            throws IOException,
                   AutomationException

Reloads data values in data graph series.

Product Availability

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

Specified by:

reload in interface IDataGraphBase

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

drawToDC

public void drawToDC(int hDC,
                     tagRECT pOutputRect,
                     tagRECT pGraphRect)
              throws IOException,
                     AutomationException

Draws the data graph into the provided device context.

Remarks

There are three parameters. They are hdc, pOutputRect, and pGraphRect. hdc means handle device context, it is used for graph drawing. pOutputRect coordinates the rectangle in device context for graph drawing. pGraphRect is the rectangle that represents the size of the graph drawn in device context. The dimension of output rectangle is usually the same as graph rectangle.

Product Availability

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

Specified by:

drawToDC in interface IDataGraphBase

Parameters:

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

pOutputRect - A Structure: com.esri.arcgis.system.tagRECT (in)

pGraphRect - A Structure: com.esri.arcgis.system.tagRECT (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadFromFile

public void loadFromFile(String filename)
                  throws IOException,
                         AutomationException

Loads the data graph from a .grf file.

Product Availability

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

Specified by:

loadFromFile in interface IDataGraphBase

Parameters:

filename - The filename (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveToFile

public void saveToFile(String filename)
                throws IOException,
                       AutomationException

Saves the data graph to a .grf file.

Product Availability

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

Specified by:

saveToFile in interface IDataGraphBase

Parameters:

filename - The filename (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportToFile

public void exportToFile(String filename)
                  throws IOException,
                         AutomationException

Exports the data graph to a file.

Remarks

fileName is the only parameter. It supports various export format, including Windows bitmap (.bmp), Encapsulated PostScript (.eps), Graphics Interchange Format (.gif), Joint Photographic Experts Group (.jpg or .jpeg), Windows Metafile (.wmf), Enhanced Windows Metafile (.emf), TeeChart Office Graphic (.tee), PC Paintbrush bitmap (.pcx), Portable Document Format (.pdf), Portable Network Graphics (.png), and Scalable Vector Graphics (.svg).

Product Availability

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

Specified by:

exportToFile in interface IDataGraphBase

Parameters:

filename - The filename (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

copyToClipboard

public void copyToClipboard()
                     throws IOException,
                            AutomationException

Copies the data graph to the clipboard as a metafile.

Product Availability

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

Specified by:

copyToClipboard in interface IDataGraphBase

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.