com.esri.arcgis.carto
Interface IImageResult

All Superinterfaces:
Serializable
All Known Subinterfaces:
ILayoutImage, IMapImage
All Known Implementing Classes:
ImageResult, LayoutImage, MapImage

public interface IImageResult
extends Serializable

Provides access to the Image Result Interface.

Remarks

MapServer output is created using ExportMapImage on IMapServer and the following methods on IMapServerLayout: ExportLayout, ExportLegend, ExportNorthArrow and ExportScaleBar. SymbolImage on MapServerLegendClass is also an ImageResult. In order to control the size of an exported map image, IMapServerInit contains two properties: MaxImageHeight and MaxImageWidth . The default value for these properties is 2048 pixels.

When To Use

Use IImageResult to access properties of MapServer output images.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 int getHeight()
          The height of the image in pixels.
 byte[] getMimeData()
          Binary data representing the generated image.
 double getReferenceDPI()
          The device resolution of the image specified in the request (dots per inch).
 String getURL()
          The URL of the generated image.
 int getWidth()
          The width of the image in pixels.
 

Method Detail

getMimeData

byte[] getMimeData()
                   throws IOException,
                          AutomationException
Binary data representing the generated image.

Remarks

If MIME is specified a stream of bytes is returned to the client.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
An unsigned byte
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getURL

String getURL()
              throws IOException,
                     AutomationException
The URL of the generated image.

Remarks

If URL is specified the image is stored as a file at the specified location (Physical Output Directory) and can be accessed by internet clients through the Virtual Output Directory.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The uRL
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHeight

int getHeight()
              throws IOException,
                     AutomationException
The height of the image in pixels.

Remarks

In order to control the size of an exported map image, IMapServerInit contains two properties: MaxImageHeight and MaxImageWidth . The default value for these properties is 2048 pixels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The heightPixels
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWidth

int getWidth()
             throws IOException,
                    AutomationException
The width of the image in pixels.

Remarks

In order to control the size of an exported map image, IMapServerInit contains two properties: MaxImageHeight and MaxImageWidth . The default value for these properties is 2048 pixels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The widthPixels
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getReferenceDPI

double getReferenceDPI()
                       throws IOException,
                              AutomationException
The device resolution of the image specified in the request (dots per inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The dpi
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.