com.esri.arcgis.carto
Interface IACMap

All Superinterfaces:

Serializable

All Known Implementing Classes:

ACMap

public interface IACMap
extends Serializable

Provides access to mebers that control the ArcIMS map service.

Product Availability

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

Method Summary

IEnvelope	getAreaOfInterest() The area of interest for the ArcIMS service.
IColor	getBackgroundColor() The background color.
String	getImageRequestXml(IEnvelope pExtent, double dpi, int width, int height, boolean scaleSymbols) The xml to request an image.
IACLayer	getLayer(int index) The layer at the given index.
int	getLayerCount() The number of layers in the ArcIMS service.
int	getMapUnits() The map units for the ArcIMS service.
int	getMaxPrintPixels() The maximum number of pixels allowed for an image print request.
ISpatialReference	getNativeSpatialReference() The native spatial reference of the data.
IColor	getTransparentColor() The transparent color.
void	moveLayer(IACLayer layer, int toIndex) Moves a layer to another position.
String	requestImage(IEnvelope pExtent, double dpi, int width, int height, boolean scaleSymbols) The new image location as an URL.
String	requestImageWithXml(String xml) The new image location as an URL.
String	sendAxlQueryRequest(String axl, ITrackCancel trackCancel, boolean showConnectingAVI, boolean processMessages) Sends an Axl query request.
String	sendAxlRequest(String axl, ITrackCancel trackCancel, boolean showConnectingAVI, boolean processMessages) Sends an Axl request.
void	setBackgroundColor(IColor color) The background color.
void	setSpatialReferenceByRef(ISpatialReference rhs1) The spatial reference of the ArcIMS service.
void	setTransparentColor(IColor color) The transparent color.

Method Detail

sendAxlRequest

String sendAxlRequest(String axl,
                      ITrackCancel trackCancel,
                      boolean showConnectingAVI,
                      boolean processMessages)
                      throws IOException,
                             AutomationException

Sends an Axl request.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

axl - The axl (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

showConnectingAVI - The showConnectingAVI (in)

processMessages - The processMessages (in)

Returns:

The response

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

sendAxlQueryRequest

String sendAxlQueryRequest(String axl,
                           ITrackCancel trackCancel,
                           boolean showConnectingAVI,
                           boolean processMessages)
                           throws IOException,
                                  AutomationException

Sends an Axl query request.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

axl - The axl (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

showConnectingAVI - The showConnectingAVI (in)

processMessages - The processMessages (in)

Returns:

The response

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

IColor getBackgroundColor()
                          throws IOException,
                                 AutomationException

The background color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackgroundColor

void setBackgroundColor(IColor color)
                        throws IOException,
                               AutomationException

The background color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTransparentColor

IColor getTransparentColor()
                           throws IOException,
                                  AutomationException

The transparent color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransparentColor

void setTransparentColor(IColor color)
                         throws IOException,
                                AutomationException

The transparent color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

requestImage

String requestImage(IEnvelope pExtent,
                    double dpi,
                    int width,
                    int height,
                    boolean scaleSymbols)
                    throws IOException,
                           AutomationException

The new image location as an URL.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

dpi - The dpi (in)

width - The width (in)

height - The height (in)

scaleSymbols - The scaleSymbols (in)

Returns:

The imageURL

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

requestImageWithXml

String requestImageWithXml(String xml)
                           throws IOException,
                                  AutomationException

The new image location as an URL. Call ImageRequestXml first.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

xml - The xml (in)

Returns:

The imageURL

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getImageRequestXml

String getImageRequestXml(IEnvelope pExtent,
                          double dpi,
                          int width,
                          int height,
                          boolean scaleSymbols)
                          throws IOException,
                                 AutomationException

The xml to request an image.

Product Availability

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

Parameters:

pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

dpi - The dpi (in)

width - The width (in)

height - The height (in)

scaleSymbols - The scaleSymbols (in)

Returns:

The xml

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerCount

int getLayerCount()
                  throws IOException,
                         AutomationException

The number of layers in the ArcIMS service.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayer

IACLayer getLayer(int index)
                  throws IOException,
                         AutomationException

The layer at the given index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.carto.IACLayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

moveLayer

void moveLayer(IACLayer layer,
               int toIndex)
               throws IOException,
                      AutomationException

Moves a layer to another position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

layer - A reference to a com.esri.arcgis.carto.IACLayer (in)

toIndex - The toIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

void setSpatialReferenceByRef(ISpatialReference rhs1)
                              throws IOException,
                                     AutomationException

The spatial reference of the ArcIMS service.

Product Availability

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

Parameters:

rhs1 - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNativeSpatialReference

ISpatialReference getNativeSpatialReference()
                                            throws IOException,
                                                   AutomationException

The native spatial reference of the data.

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.ISpatialReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAreaOfInterest

IEnvelope getAreaOfInterest()
                            throws IOException,
                                   AutomationException

The area of interest for the ArcIMS service.

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.

getMapUnits

int getMapUnits()
                throws IOException,
                       AutomationException

The map units for the ArcIMS service.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.gisclient.acMapUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxPrintPixels

int getMaxPrintPixels()
                      throws IOException,
                             AutomationException

The maximum number of pixels allowed for an image print request.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pMaxPrintPixels

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.