Creating Image Files

• getDocumentHeightInPoints(); Get Document Height In Points
• getDocumentWidthInPoints(); Get Document Width In Points
• sendGIFToFile(); Send chart to a file as a GIF image
• sendGIFToFileExc(); Send chart to a file as a GIF image with exceptions
• sendGIFToFTP(); Send a GIF image using FTP
• sendGIFToStream(); Send chart to a stream as a GIF image
• sendImageMapToStream(); Send image map to stream
• sendJPEGToStream(); Send chart to a file as a JPEG image
• sendPNGToFile(); Send chart to a file as a PNG image
• sendPNGToFileExc(); Send chart to a file as a PNG image with exceptions
• sendPNGToStream(); Send a PNG image to stream
• sendPNGToStreamExc(); Send a PNG image to stream with exceptions
• sendSVGToStream(); Send chrt to stream as an SVG image

getDocumentHeightInPoints()

This method returns the document/chart height in points. It is a convenience function that converts the document height in TWIPs to points. The height in TWIPs is defined by the DocumentHeightInTwips property.

SYNTAX:

int getDocumentHeightInPoints();

INPUT:

None

RETURN:

int; document height in points

NOTES:

A TWIP is 1/20th point or 1/100th millimeter. The document size is used to calculate the size of text using absolute font sizes.

ALSO SEE:

DocumentHeightInTwips, setFontSizeAbsolute()

getDocumentWidthInPoints()

This method returns the document width in points. It is a convenience function that converts the document width in TWIPs (set by setDocumentWidthInTwips()) to points.

SYNTAX:

int getDocumentWidthInPoints();

INPUT:

None

RETURN:

int; document width in points

NOTES:

A TWIP is 1/20th point or 1/100th millimeter. The document size is used to calculate the size of text using absolute font sizes.

ALSO SEE:

DocumentWidthInTwips, setFontSizeAbsolute()

sendGIFToFile()

This method sends the current chart to a file as a GIF image.

SYNTAX:

void sendGIFToFile ( os OutputStream);

INPUT:

os; output stream

RETURN:

void;

ALSO SEE:

sendChartToFTP(), sendGIFToFTP(), sendGIFToStream()

sendGIFToFileExc()

This method sends the current chart to a file as a GIF image and throws the appropriate exception(s).

SYNTAX:

void sendGIFToFileExc (OutputStream outS)

INPUT:

outS; output stream

RETURN:

void;

Note:

Exceptions are not caught in this version of code

ALSO SEE:

sendGIFToFile(), sendGIFToFTP(), sendGIFToStream()

sendGIFToFTP()

This method sends the current chart to an FTP server as a Graphics Interchange Format (GIF) image.

SYNTAX:

void sendGIFToFTP (      String strHost,      String strUser,      String strPass,      String strDir,      String strDestFile );

INPUT:

strHost; Host Name string

strUser; User Name string

strPass; Password string

strDir; Directory name string

strDestFile; Destination file name string

RETURN:

void

ALSO SEE:

sendGIFToFile(), sendGIFToStream()

sendGIFToStream()

This method sends the current chart to an output stream as a GIF image.

SYNTAX:

void sendGIFToStream (os OutputStream);

INPUT:

os; output stream

RETURN:

void

ALSO SEE:

sendGIFToFile(), sendGIFToFTP()

sendImageMapToStream()

This method creates a map of the image that forms a chart and sends it to a Java I/O PrinterWriter object.

SYNTAX:

void sendImageMapToStream (      java.io.PrintWriter outWriter,      String mapName,      String pathName,      boolean bPage )

INPUT:

outWriter; A Java I/O PrinterWriter object

mapName; Name of ImageMap.

pathName; Name of the path to write ImageMap to.

bPage; true = pageable, false = non-pageable

RETURN:

void

ALSO SEE:

sendGIFToStream()

sendJPEGToStream()

This method sends the chart to an output stream in JPEG format.

SYNTAX:

void sendJPEGToStream (OutputStream outS, int nJPEGQuality)

INPUT:

outS; output stream

nJPEGQuality; JPEG quality number

RETURN:

void;

sendPNGToFile()

This method writes the chart image to the specified file in Portable Network Graphs (.png) format. Any errors are passed to TDGErrorListeners with an ID of TDGError.WRITE_ERROR.

SYNTAX:

void sendPNGToFile (java.io.File pngFile)

INPUT:

pngFile; File to write the chart image to

RETURN:

void

ALSO SEE:

sendPNGToFileExc(), sendPNGToStream()

sendPNGToFileExc()

This method saves the chart in a file in Portable Network Graphs (.png) format and throws the appropriate exception (s).

SYNTAX:

void sendPNGToFileExc (File pngFile)

INPUT:

pngFile; File were chart image will be stored

RETURN:

void;

ALSO SEE:

sendPNGtoFile(), sendPNGToStream(), sendPNGToStreamExc()

sendPNGToStream()

This method writes the chart image to the specified output stream in Portable Network Graphs (.png) format. Any errors are passed to TDGErrorListeners with an ID of TDGError.WRITE_ERROR.

SYNTAX:

void sendPNGToStream (java.io.OutputStream pngStream);

INPUT:

pngStream; Stream to write the chart image to.

RETURN:

void

ALSO SEE:

sendPNGToFile()

sendPNGToStreamExc()

This method writes the chart image to the specified stream in Portable Network Graphs (.png) format and throws the appropriate exception (s).

SYNTAX:

void sendPNGToStreamExc (OutputStream pngStream);

INPUT:

pngStream; output to stream

RETURN:

void;

ALSO SEE:

sendPNGToFileExc()

sendSVGToStream()

This method sends a chart to an output stream in Scalable Vector Graphics (SVG) format. The OutputSVG property enables/disables SVG output.

SYNTAX:

void sendSVGToStream (OutputStream outS);

INPUT:

outS; output stream value

RETURN:

void;

ALSO SEE:

OutputSVG, DocumentHeightInTwips, DocumentWidthInTwips