com.esri.arcgis.carto
Interface IIMSMapLayer

All Superinterfaces:
ILayer, Serializable
All Known Implementing Classes:
IMSMapLayer

public interface IIMSMapLayer
extends ILayer, Serializable

Provides access to members that control the IMS map layer.

When To Use

Use IIMSMapLayer to access members that control the IMS map layer. The IMS map layer refers specifically to ArcIMS Image Service layers. IIMSMapLayer is not applicable to other service layers such as ArcIMS Feature Services.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void clearDrawCache()
          Clears the cache of images downloaded from the IMS server for drawing.
 void connectToService(IIMSServiceDescription service)
          Connects to the map service with the given server url.
 IIMSServiceDescription getConnection()
          The service.
 IACMap getIMSMap()
          The IMS map.
 void moveSubLayerTo(IIMSSubLayer subLayer, int index)
          Change the sublayer order.
 void setAreaOfInterest(IEnvelope rhs1)
          The area of interest.
 
Methods inherited from interface com.esri.arcgis.carto.ILayer
draw, getAreaOfInterest, getMaximumScale, getMinimumScale, getName, getSupportedDrawPhases, getTipText, isCached, isShowTips, isValid, isVisible, setCached, setMaximumScale, setMinimumScale, setName, setShowTips, setSpatialReferenceByRef, setVisible
 

Method Detail

getConnection

IIMSServiceDescription getConnection()
                                     throws IOException,
                                            AutomationException
The 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.gisclient.IIMSServiceDescription
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

connectToService

void connectToService(IIMSServiceDescription service)
                      throws IOException,
                             AutomationException
Connects to the map service with the given server url.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
service - A reference to a com.esri.arcgis.gisclient.IIMSServiceDescription (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

moveSubLayerTo

void moveSubLayerTo(IIMSSubLayer subLayer,
                    int index)
                    throws IOException,
                           AutomationException
Change the sublayer order.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
subLayer - A reference to a com.esri.arcgis.carto.IIMSSubLayer (in)
index - The index (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getIMSMap

IACMap getIMSMap()
                 throws IOException,
                        AutomationException
The IMS map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setAreaOfInterest

void setAreaOfInterest(IEnvelope rhs1)
                       throws IOException,
                              AutomationException
The area of interest.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

clearDrawCache

void clearDrawCache()
                    throws IOException,
                           AutomationException
Clears the cache of images downloaded from the IMS server for drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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