com.esri.arcgis.output
Interface IExportTIFF

All Superinterfaces:

Serializable

All Known Implementing Classes:

ExportTIFF

public interface IExportTIFF
extends Serializable

Provides access to members that control the TIFF (Tagged Image File Format) Export.

Product Availability

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

Method Summary

int	getBiLevelThreshold() The Threshold value for BiLevel images.
int	getCompressionType() The TIFF Compression type.
short	getJPEGOrDeflateQuality() This option controls the Quality setting for Flate or JPEG compression options.
boolean	isGeoTiff() The option to write GeoTIFF tags.
void	setBiLevelThreshold(int threshold) The Threshold value for BiLevel images.
void	setCompressionType(int type) The TIFF Compression type.
void	setGeoTiff(boolean bGeoTiff) The option to write GeoTIFF tags.
void	setJPEGOrDeflateQuality(short quality) This option controls the Quality setting for Flate or JPEG compression options.

Method Detail

setCompressionType

void setCompressionType(int type)
                        throws IOException,
                               AutomationException

The TIFF Compression type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

type - A com.esri.arcgis.output.esriTIFFCompression constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCompressionType

int getCompressionType()
                       throws IOException,
                              AutomationException

The TIFF Compression type.

Remarks

The selected compression type must be appropriate for the current image type. The image type can be set via the IExportImage::ImageType property. If you select the wrong image compression type for the current image type, selecting esriTIFFCompressionFax4 for a TrueColor image, for example, the export object will throw a runtime error. The error will state "Object set up incorrectly and cannot perform the requested operation."

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.output.esriTIFFCompression constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeoTiff

void setGeoTiff(boolean bGeoTiff)
                throws IOException,
                       AutomationException

The option to write GeoTIFF tags.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

bGeoTiff - The bGeoTiff (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isGeoTiff

boolean isGeoTiff()
                  throws IOException,
                         AutomationException

The option to write GeoTIFF tags.

Remarks

Value of True will write a GeoTiff header in the output TIFF file. The GeoTiff header will include the spatial reference values assigned to IWorldFileSettings::MapExtent.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The bGeoTiff

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setJPEGOrDeflateQuality

void setJPEGOrDeflateQuality(short quality)
                             throws IOException,
                                    AutomationException

This option controls the Quality setting for Flate or JPEG compression options. Range (0..100). Default is 100 (best compression for flate / best quality for JPEG). Higher values result in smaller files for flate, and larger files for JPEG.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

quality - The quality (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJPEGOrDeflateQuality

short getJPEGOrDeflateQuality()
                              throws IOException,
                                     AutomationException

This option controls the Quality setting for Flate or JPEG compression options. Range (0..100). Default is 100 (best compression for flate / best quality for JPEG). Higher values result in smaller files for flate, and larger files for JPEG.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The quality

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBiLevelThreshold

void setBiLevelThreshold(int threshold)
                         throws IOException,
                                AutomationException

The Threshold value for BiLevel images. The Threshold value will be used if esriExportImageType equal to esriExportImageTypeBiLevelThreshold.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

threshold - The threshold (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBiLevelThreshold

int getBiLevelThreshold()
                        throws IOException,
                               AutomationException

The Threshold value for BiLevel images. The Threshold value will be used if esriExportImageType equal to esriExportImageTypeBiLevelThreshold.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The threshold

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.