com.esri.arcgis.carto
Interface IMapImage

All Superinterfaces:
IImageResult, Serializable
All Known Implementing Classes:
MapImage

public interface IMapImage
extends IImageResult, Serializable

Provides access to the Map Image Interface.

Remarks

The MapImage coclass is a subclass of ImageResult and will inherit all IImageResult properties.

When To Use

Use IMapImage to access properties of an ExportMapImage result.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 IEnvelope getMapExtent()
          The geographic extent of the map that is fitted to the height and width of the generated image.
 double getMapScale()
          The scale of the generated map image.
 ILongArray getVisibleLayers()
          Array of the visible layers drawn for the generated map scale.
 
Methods inherited from interface com.esri.arcgis.carto.IImageResult
getHeight, getMimeData, getReferenceDPI, getURL, getWidth
 

Method Detail

getMapExtent

IEnvelope getMapExtent()
                       throws IOException,
                              AutomationException
The geographic extent of the map that is fitted to the height and width of the generated image.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVisibleLayers

ILongArray getVisibleLayers()
                            throws IOException,
                                   AutomationException
Array of the visible layers drawn for the generated map scale.

Remarks

VisibleLayers is defined by a combination of layer visibility in the TOC (i.e. is the layer "on"?) and layer visibility dependent on map scale. Scale dependency for a layer is set in the original map document. If the layer is scale dependent (i.e. a maximum and/or minimum scale has been set) and the map scale falls out of this range, layer visibility will be false. Do not confuse this property with the visibility property on ILayerDescription which is based solely on layer visibility in the TOC (is the layer "on" or "off"). The IMapImage interface inherits all IImageResult properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.system.ILongArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapScale

double getMapScale()
                   throws IOException,
                          AutomationException
The scale of the generated map image.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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