|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.esri.arcgis.cartoUI.DataGraphT
public class DataGraphT
A container for the display and manipulation of graph series.
DataGraphT is the container for graph series, it can be cocreated. Each graph should contain at least one series. To make a series (which is a non-cocreatable object), AddSeries (IDataGraphT::AddSeries) should be used. There are two kinds of series, they are graph series and function series (it also implements IFunctionSeriesProperties). A series can be added (IDataGraphT::AddSeries), removed (IDataGraphT::RemoveSeries), or reordered (IDataGraphT::SeriesOrder). Graph series can be made from feature layer, raster layer, or standalone table. Function series can only be made from existing graph series. Graph can either be displayed on graph window (IDataGraphWindow2 from DataGraphWindow coclass), or be displayed on layout view. Graphs are saved either within map document (IDataGraphCollection), or as grf file.
DataGraphT implements three interfaces, they are IDatagraphT, IDataGraphBase, and IDataGraphTEvents . There are different properties setting in a graph. They include legend properties, axis properties, and general properties.
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).
| Constructor Summary | |
|---|---|
DataGraphT()
Constructs a DataGraphT using ArcGIS Engine. |
|
DataGraphT(Object obj)
Construct a DataGraphT using a reference to such an object returned from ArcGIS Engine or Server. |
|
| Method Summary | |
|---|---|
void |
addIDataGraphTEventsListener(IDataGraphTEvents theListener)
addIDataGraphTEventsListener. |
ISeriesProperties |
addSeries(String seriesType)
Add series from the provided graph type. |
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 |
enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
enumConnectionPoints |
boolean |
equals(Object o)
Compare this object with another |
void |
exportToFile(String filename)
Exports the data graph to a file. |
void |
exportToFileEx(String filename,
int width,
int height)
Exports the data graph to a file. |
void |
findConnectionPoint(GUID riid,
IConnectionPoint[] ppCP)
findConnectionPoint |
int |
getAxisCount()
Amount of axis. |
IDataGraphTAxisProperties |
getAxisProperties(int idx)
Properties of graph axis. |
void |
getClassID(GUID[] pClassID)
getClassID |
static String |
getClsid()
getClsid. |
IDataGraphTGeneralProperties |
getGeneralProperties()
General properties of the graph. |
IDataGraphTLegendProperties |
getLegendProperties()
Properties of graph legend. |
String |
getName()
Name of the data graph. |
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 |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
int |
hashCode()
the hashcode for this object |
void |
identify(int iSeries,
int ptX,
int ptY,
Object[] pOIDs)
Identifies object ID for the series using graph coordinates. |
void |
isDirty()
isDirty |
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. |
boolean |
isUseSelectedSet()
Indicates if the selected set of the series from input dataset is used to build graph. |
void |
load(IStream pstm)
load |
void |
loadFromFile(String filename)
Loads the data graph from a .grf file. |
void |
loadTemplate(String file)
Loads graph properties from the template file. |
void |
onAbortEditOperation(IWorkspaceEditEventsOnAbortEditOperationEvent theEvent)
This event is fired after an edit operation is aborted. |
void |
onRedoEditOperation(IWorkspaceEditEventsOnRedoEditOperationEvent theEvent)
This event is fired after an undone edit operation is redone. |
void |
onStartEditing(IWorkspaceEditEventsOnStartEditingEvent theEvent)
This event is fired after editing is started on a workspace. |
void |
onStartEditOperation(IWorkspaceEditEventsOnStartEditOperationEvent theEvent)
This event is fired after an edit operation is started. |
void |
onStopEditing(IWorkspaceEditEventsOnStopEditingEvent theEvent)
This event is fired after editing is stopped on a workspace. |
void |
onStopEditOperation(IWorkspaceEditEventsOnStopEditOperationEvent theEvent)
This event is fired after an edit operation is stopped (successfully completed). |
void |
onUndoEditOperation(IWorkspaceEditEventsOnUndoEditOperationEvent theEvent)
This event is fired after a (completed) edit operation is undone. |
void |
readExternal(ObjectInput in)
|
void |
reload()
Reloads data values in data graph series. |
void |
removeIDataGraphTEventsListener(IDataGraphTEvents theListener)
removeIDataGraphTEventsListener. |
void |
removeSeries(ISeriesProperties pSeriesProps)
Remove series from the graph. |
void |
save(IStream pstm,
int fClearDirty)
save |
void |
saveToFile(String filename)
Saves the data graph to a .grf file. |
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 |
setName(String pName)
Name of the data graph. |
void |
setSeriesOrder(ISeriesProperties pSeriesProps,
int pPos)
Position of the series in the series list of the graph. |
void |
setUseSelectedSet(boolean pUseSel)
Indicates if the selected set of the series from input dataset is used to build graph. |
void |
update(ITrackCancel pCancel)
Updates graph after changes in graph or series properties. |
void |
writeExternal(ObjectOutput out)
|
| 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 |
|---|
public DataGraphT()
throws IOException,
UnknownHostException
IOException - if there are interop problems
UnknownHostException - if there are interop problems
public DataGraphT(Object obj)
throws IOException
obj to DataGraphT.
obj - an object returned from ArcGIS Engine or Server
IOException - if there are interop problems
DataGraphT theDataGraphT = (DataGraphT) obj;| Method Detail |
|---|
public static String getClsid()
public boolean equals(Object o)
equals in class Objectpublic int hashCode()
hashCode in class Object
public void addIDataGraphTEventsListener(IDataGraphTEvents theListener)
throws IOException
theListener - An object that implements the com.esri.arcgis.carto.IDataGraphTEvents interface.
IOException - If there are communications problems.
public void removeIDataGraphTEventsListener(IDataGraphTEvents theListener)
throws IOException
theListener - An object that implements the com.esri.arcgis.carto.IDataGraphTEvents interface.
IOException - If there are communications problems.
public String getName()
throws IOException,
AutomationException
getName in interface IDataGraphBaseIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setName(String pName)
throws IOException,
AutomationException
setName in interface IDataGraphBasepName - The pName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isUseSelectedSet()
throws IOException,
AutomationException
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).
isUseSelectedSet in interface IDataGraphBaseIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setUseSelectedSet(boolean pUseSel)
throws IOException,
AutomationException
setUseSelectedSet in interface IDataGraphBasepUseSel - The pUseSel (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void reload()
throws IOException,
AutomationException
reload in interface IDataGraphBaseIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void drawToDC(int hDC,
tagRECT pOutputRect,
tagRECT pGraphRect)
throws IOException,
AutomationException
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.
drawToDC in interface IDataGraphBasehDC - The hDC (A COM typedef) (in)pOutputRect - A Structure: com.esri.arcgis.system.tagRECT (in)pGraphRect - A Structure: com.esri.arcgis.system.tagRECT (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void loadFromFile(String filename)
throws IOException,
AutomationException
loadFromFile in interface IDataGraphBasefilename - The filename (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void saveToFile(String filename)
throws IOException,
AutomationException
saveToFile in interface IDataGraphBasefilename - The filename (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void exportToFile(String filename)
throws IOException,
AutomationException
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).
exportToFile in interface IDataGraphBasefilename - The filename (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void copyToClipboard()
throws IOException,
AutomationException
copyToClipboard in interface IDataGraphBaseIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isHighlightSelection()
throws IOException,
AutomationException
isHighlightSelection in interface IDataGraphTIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setHighlightSelection(boolean b)
throws IOException,
AutomationException
setHighlightSelection in interface IDataGraphTb - The b (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISeriesProperties addSeries(String seriesType)
throws IOException,
AutomationException
addSeries in interface IDataGraphTseriesType - The seriesType (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void removeSeries(ISeriesProperties pSeriesProps)
throws IOException,
AutomationException
removeSeries in interface IDataGraphTpSeriesProps - A reference to a com.esri.arcgis.carto.ISeriesProperties (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getSeriesCount()
throws IOException,
AutomationException
getSeriesCount in interface IDataGraphTIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISeriesProperties getSeriesProperties(int iSeries)
throws IOException,
AutomationException
getSeriesProperties in interface IDataGraphTiSeries - The iSeries (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSeriesOrder(ISeriesProperties pSeriesProps,
int pPos)
throws IOException,
AutomationException
setSeriesOrder in interface IDataGraphTpSeriesProps - A reference to a com.esri.arcgis.carto.ISeriesProperties (in)pPos - The pPos (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getSeriesOrder(ISeriesProperties pSeriesProps)
throws IOException,
AutomationException
getSeriesOrder in interface IDataGraphTpSeriesProps - A reference to a com.esri.arcgis.carto.ISeriesProperties (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IDataGraphTGeneralProperties getGeneralProperties()
throws IOException,
AutomationException
getGeneralProperties in interface IDataGraphTIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IDataGraphTLegendProperties getLegendProperties()
throws IOException,
AutomationException
getLegendProperties in interface IDataGraphTIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getAxisCount()
throws IOException,
AutomationException
getAxisCount in interface IDataGraphTIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IDataGraphTAxisProperties getAxisProperties(int idx)
throws IOException,
AutomationException
getAxisProperties in interface IDataGraphTidx - The idx (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void identify(int iSeries,
int ptX,
int ptY,
Object[] pOIDs)
throws IOException,
AutomationException
identify in interface IDataGraphTiSeries - The iSeries (in)ptX - The ptX (in)ptY - The ptY (in)pOIDs - A Variant (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void update(ITrackCancel pCancel)
throws IOException,
AutomationException
update in interface IDataGraphTpCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void loadTemplate(String file)
throws IOException,
AutomationException
loadTemplate in interface IDataGraphTfile - The file (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void exportToFileEx(String filename,
int width,
int height)
throws IOException,
AutomationException
exportToFileEx in interface IDataGraphTfilename - The filename (in)width - The width (in)height - The height (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void isDirty()
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty in interface IPersistStreamIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void load(IStream pstm)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void save(IStream pstm,
int fClearDirty)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)fClearDirty - The fClearDirty (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax in interface IPersistStreampcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getClassID(GUID[] pClassID)
throws IOException,
AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID in interface IPersistpClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
throws IOException,
AutomationException
IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.
enumConnectionPoints in interface IConnectionPointContainerppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void findConnectionPoint(GUID riid,
IConnectionPoint[] ppCP)
throws IOException,
AutomationException
IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.
findConnectionPoint in interface IConnectionPointContainerriid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void onStartEditing(IWorkspaceEditEventsOnStartEditingEvent theEvent)
throws IOException,
AutomationException
onStartEditing in interface IWorkspaceEditEventstheEvent - The event
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void onStopEditing(IWorkspaceEditEventsOnStopEditingEvent theEvent)
throws IOException,
AutomationException
onStopEditing in interface IWorkspaceEditEventstheEvent - The event
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void onStartEditOperation(IWorkspaceEditEventsOnStartEditOperationEvent theEvent)
throws IOException,
AutomationException
onStartEditOperation in interface IWorkspaceEditEventstheEvent - The event
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void onAbortEditOperation(IWorkspaceEditEventsOnAbortEditOperationEvent theEvent)
throws IOException,
AutomationException
onAbortEditOperation in interface IWorkspaceEditEventstheEvent - The event
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void onStopEditOperation(IWorkspaceEditEventsOnStopEditOperationEvent theEvent)
throws IOException,
AutomationException
onStopEditOperation in interface IWorkspaceEditEventstheEvent - The event
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void onUndoEditOperation(IWorkspaceEditEventsOnUndoEditOperationEvent theEvent)
throws IOException,
AutomationException
onUndoEditOperation in interface IWorkspaceEditEventstheEvent - The event
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void onRedoEditOperation(IWorkspaceEditEventsOnRedoEditOperationEvent theEvent)
throws IOException,
AutomationException
onRedoEditOperation in interface IWorkspaceEditEventstheEvent - The event
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void writeExternal(ObjectOutput out)
throws IOException
writeExternal in interface ExternalizableIOException
public void readExternal(ObjectInput in)
throws IOException,
ClassNotFoundException
readExternal in interface ExternalizableIOException
ClassNotFoundException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||