com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class SaveGraph

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.SaveGraph

All Implemented Interfaces:

GPTool

public class SaveGraph
extends AbstractGPTool

Saves a graph to an image, vector, or graph file. The Save Graph tool is contained in the Data Management Tools tool box.

Usage tips:

• Image formatsVector formatsWindows Bitmap (.bmp)Scalable Vector Graphics (.svg)GIF(.gif)Adobe Acrobat PDF (.pdf)JPEG (.jpg)Encapsulated PostsScript (.eps)Portable Network Graphic (.png)Enhanced Metafile (.emf)Paintbrush (.pcx)Windows Metafile (.wmf)
• When saving the graph to the desired format, you need to specify the file extension in the output file name. For example, if you want to export a graph to a Windows Bitmap, you need to specify the output file name as C:\temp\outGraph.bmp.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

SaveGraph()
Creates the Save Graph tool with defaults.

SaveGraph(Object inGraph, Object outGraphFile)
Creates the Save Graph tool with the required parameters.

Method Summary

int	getImageHeight() Returns the Output image height parameter of this tool .
int	getImageWidth() Returns the Output image width parameter of this tool .
Object	getInGraph() Returns the Input graph parameter of this tool .
String	getMaintainImageAspect() Returns the Maintain aspect ratio of output image parameter of this tool .
Object	getOutGraphFile() Returns the Output graph file parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
void	setImageHeight(int imageHeight) Sets the Output image height parameter of this tool .
void	setImageWidth(int imageWidth) Sets the Output image width parameter of this tool .
void	setInGraph(Object inGraph) Sets the Input graph parameter of this tool .
void	setMaintainImageAspect(String maintainImageAspect) Sets the Maintain aspect ratio of output image parameter of this tool .
void	setOutGraphFile(Object outGraphFile) Sets the Output graph file parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SaveGraph

public SaveGraph()

Creates the Save Graph tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

SaveGraph

public SaveGraph(Object inGraph,
                 Object outGraphFile)

Creates the Save Graph tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

inGraph - input graph name or location. you can input the location of an existing graph file (*.grf). however, when you are using the tool in an ArcGIS application (ArcMap, ArcGlobe, or ArcScene), you can either input a graph present in the ArcGIS document or you can input the location of an existing graph file (*.grf).

outGraphFile - the output image, vector, or graph file. the supported image and vector formats are:

• Windows Bitmap (.bmp)
• GIF(.gif)
• JPEG (.jpg)
• Portable Network Graphic (.png)
• Paintbrush (.pcx)
• Scalable Vector Graphics (.svg)
• Adobe Acrobat PDF (.pdf)
• Encapsulated PostsScript (.eps)
• Enhanced Metafile (.emf)
• Windows Metafile (.wmf)

Method Detail

getInGraph

public Object getInGraph()

Returns the Input graph parameter of this tool . This parameter is input graph name or location. you can input the location of an existing graph file (*.grf). however, when you are using the tool in an ArcGIS application (ArcMap, ArcGlobe, or ArcScene), you can either input a graph present in the ArcGIS document or you can input the location of an existing graph file (*.grf). This is a required parameter.

Returns:

the Input graph

setInGraph

public void setInGraph(Object inGraph)

Sets the Input graph parameter of this tool . This parameter is input graph name or location. you can input the location of an existing graph file (*.grf). however, when you are using the tool in an ArcGIS application (ArcMap, ArcGlobe, or ArcScene), you can either input a graph present in the ArcGIS document or you can input the location of an existing graph file (*.grf). This is a required parameter.

Parameters:

inGraph - input graph name or location. you can input the location of an existing graph file (*.grf). however, when you are using the tool in an ArcGIS application (ArcMap, ArcGlobe, or ArcScene), you can either input a graph present in the ArcGIS document or you can input the location of an existing graph file (*.grf).

getOutGraphFile

public Object getOutGraphFile()

Returns the Output graph file parameter of this tool . This parameter is the output image, vector, or graph file. the supported image and vector formats are: This is a required parameter.

Returns:

the Output graph file

setOutGraphFile

public void setOutGraphFile(Object outGraphFile)

Sets the Output graph file parameter of this tool . This parameter is the output image, vector, or graph file. the supported image and vector formats are: This is a required parameter.

Parameters:

outGraphFile - the output image, vector, or graph file. the supported image and vector formats are:

• Windows Bitmap (.bmp)
• GIF(.gif)
• JPEG (.jpg)
• Portable Network Graphic (.png)
• Paintbrush (.pcx)
• Scalable Vector Graphics (.svg)
• Adobe Acrobat PDF (.pdf)
• Encapsulated PostsScript (.eps)
• Enhanced Metafile (.emf)
• Windows Metafile (.wmf)

getMaintainImageAspect

public String getMaintainImageAspect()

Returns the Maintain aspect ratio of output image parameter of this tool . This is an optional parameter.

Returns:

the Maintain aspect ratio of output image

setMaintainImageAspect

public void setMaintainImageAspect(String maintainImageAspect)

Sets the Maintain aspect ratio of output image parameter of this tool . This is an optional parameter.

Parameters:

maintainImageAspect - null

getImageWidth

public int getImageWidth()

Returns the Output image width parameter of this tool . This parameter is the width of the output image in pixels. This is an optional parameter.

Returns:

the Output image width

setImageWidth

public void setImageWidth(int imageWidth)

Sets the Output image width parameter of this tool . This parameter is the width of the output image in pixels. This is an optional parameter.

Parameters:

imageWidth - the width of the output image in pixels.

getImageHeight

public int getImageHeight()

Returns the Output image height parameter of this tool . This parameter is the height of the output image in pixels. This is an optional parameter.

Returns:

the Output image height

setImageHeight

public void setImageHeight(int imageHeight)

Sets the Output image height parameter of this tool . This parameter is the height of the output image in pixels. This is an optional parameter.

Parameters:

imageHeight - the height of the output image in pixels.

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias