com.esri.arcgis.controls
Interface IARMap

All Superinterfaces:
Serializable
All Known Implementing Classes:
ARMap, IARMapProxy

public interface IARMap
extends Serializable

Provides access to members that control the ARMap.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.


Method Summary
 void centerAt(double xCoord, double yCoord)
          Moves the center of the map to the specified point.
 void centerAtBookmark(Object vBookmarkID)
          Centers the map display on the bookmark.
 IARLayer getARLayer(int index)
          The layer at the specified index.
 int getARLayerCount()
          The number of layer in the map's layer collection.
 int getBookmarkCount()
          The number of bookmarks in the map's bookmark collection.
 String getBookmarkName(int index)
          The name of the bookmark.
 Object getCustomProperty()
          A property to associate data with an object.
 String getDescription()
          The description of the map.
 int getDistanceUnits()
          The distance units of the map.
 void getExtent(double[] xMin, double[] yMin, double[] xMax, double[] yMax)
          The visible extent of the map.
 void getFullExtent(double[] xMin, double[] yMin, double[] xMax, double[] yMax)
          The extent of all the data within the map.
 Object getInternalObject()
          The internal ArcObjects IMap object.
 double getMapScale()
          The scale of the map as a representative fraction.
 int getMapUnits()
          The geographical units of the map.
 String getName()
          The name of the map.
 double getReferenceScale()
          The reference scale of the map as a representative fraction.
 double getRotation()
          The number of degrees the map display is rotated.
 String getSpatialReferenceName()
          The name of the map's spatial reference.
 boolean isCanRedoExtent()
          Indicates if there is a map extent that can be redone.
 boolean isCanUndoExtent()
          Indicates if there is a map extent that can be undone.
 void pan(int direction, double screenPercentage)
          Pans the map by a factor in a specified direction.
 IARFeatureSet queryARFeatures(IARSearchDef pSearchDef)
          Searches the map using a search definition and returns an ARFeatureSet.
 void redoExtent()
          Redo the next map extent in the stack.
 void refresh(boolean refreshNow)
          Redraws the map display area.
 IARFeatureCursor searchARFeatures(IARSearchDef pSearchDef)
          Searches the map using a search definition and returns an ARFeatureCursor.
 void setCustomProperty(Object pVal)
          A property to associate data with an object.
 void setExtent(double xMin, double yMin, double xMax, double yMax)
          Sets the visible extent of the map.
 void setMapScale(double mapScale)
          The scale of the map as a representative fraction.
 void setRotation(double mapRotation)
          The number of degrees the map display is rotated.
 void toMapPoint(int x, int y, double[] xCoord, double[] yCoord)
          Converts a point in device coordinates (typically pixels) to coordinates in map units.
 void undoExtent()
          Undo to the previous map extent in the stack.
 void zoomIn(double factor)
          Zooms in on the map by a factor.
 void zoomOut(double factor)
          Zooms out on the map by a factor.
 void zoomToBookmark(Object vBookmarkID)
          Zooms the map display to the bookmark.
 void zoomToFullExtent()
          Zoom to the full extent of all data within the map.
 

Method Detail

setMapScale

void setMapScale(double mapScale)
                 throws IOException,
                        AutomationException
The scale of the map as a representative fraction.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
mapScale - The mapScale (in)
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 map as a representative fraction.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

refresh

void refresh(boolean refreshNow)
             throws IOException,
                    AutomationException
Redraws the map display area.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
refreshNow - The refreshNow (in, optional, pass false if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException
The name of the map.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getARLayerCount

int getARLayerCount()
                    throws IOException,
                           AutomationException
The number of layer in the map's layer collection.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getARLayer

IARLayer getARLayer(int index)
                    throws IOException,
                           AutomationException
The layer at the specified index.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getDescription

String getDescription()
                      throws IOException,
                             AutomationException
The description of the map.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getSpatialReferenceName

String getSpatialReferenceName()
                               throws IOException,
                                      AutomationException
The name of the map's spatial reference.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getMapUnits

int getMapUnits()
                throws IOException,
                       AutomationException
The geographical units of the map.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:
A com.esri.arcgis.controls.esriARUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDistanceUnits

int getDistanceUnits()
                     throws IOException,
                            AutomationException
The distance units of the map.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:
A com.esri.arcgis.controls.esriARUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExtent

void setExtent(double xMin,
               double yMin,
               double xMax,
               double yMax)
               throws IOException,
                      AutomationException
Sets the visible extent of the map.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
xMin - The xMin (in)
yMin - The yMin (in)
xMax - The xMax (in)
yMax - The yMax (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

void getExtent(double[] xMin,
               double[] yMin,
               double[] xMax,
               double[] yMax)
               throws IOException,
                      AutomationException
The visible extent of the map.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
xMin - The xMin (in/out: use single element array)
yMin - The yMin (in/out: use single element array)
xMax - The xMax (in/out: use single element array)
yMax - The yMax (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFullExtent

void getFullExtent(double[] xMin,
                   double[] yMin,
                   double[] xMax,
                   double[] yMax)
                   throws IOException,
                          AutomationException
The extent of all the data within the map.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
xMin - The xMin (in/out: use single element array)
yMin - The yMin (in/out: use single element array)
xMax - The xMax (in/out: use single element array)
yMax - The yMax (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getReferenceScale

double getReferenceScale()
                         throws IOException,
                                AutomationException
The reference scale of the map as a representative fraction.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

zoomIn

void zoomIn(double factor)
            throws IOException,
                   AutomationException
Zooms in on the map by a factor.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
factor - The factor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

zoomOut

void zoomOut(double factor)
             throws IOException,
                    AutomationException
Zooms out on the map by a factor.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
factor - The factor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

pan

void pan(int direction,
         double screenPercentage)
         throws IOException,
                AutomationException
Pans the map by a factor in a specified direction.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
direction - A com.esri.arcgis.controls.esriARDirection constant (in)
screenPercentage - The screenPercentage (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

centerAt

void centerAt(double xCoord,
              double yCoord)
              throws IOException,
                     AutomationException
Moves the center of the map to the specified point.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
xCoord - The xCoord (in)
yCoord - The yCoord (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRotation

void setRotation(double mapRotation)
                 throws IOException,
                        AutomationException
The number of degrees the map display is rotated.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
mapRotation - The mapRotation (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRotation

double getRotation()
                   throws IOException,
                          AutomationException
The number of degrees the map display is rotated.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

queryARFeatures

IARFeatureSet queryARFeatures(IARSearchDef pSearchDef)
                              throws IOException,
                                     AutomationException
Searches the map using a search definition and returns an ARFeatureSet.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
pSearchDef - A reference to a com.esri.arcgis.controls.IARSearchDef (in)
Returns:
A reference to a com.esri.arcgis.controls.IARFeatureSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

toMapPoint

void toMapPoint(int x,
                int y,
                double[] xCoord,
                double[] yCoord)
                throws IOException,
                       AutomationException
Converts a point in device coordinates (typically pixels) to coordinates in map units.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
x - The x (in)
y - The y (in)
xCoord - The xCoord (in/out: use single element array)
yCoord - The yCoord (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanUndoExtent

boolean isCanUndoExtent()
                        throws IOException,
                               AutomationException
Indicates if there is a map extent that can be undone.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

undoExtent

void undoExtent()
                throws IOException,
                       AutomationException
Undo to the previous map extent in the stack.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

isCanRedoExtent

boolean isCanRedoExtent()
                        throws IOException,
                               AutomationException
Indicates if there is a map extent that can be redone.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

redoExtent

void redoExtent()
                throws IOException,
                       AutomationException
Redo the next map extent in the stack.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getInternalObject

Object getInternalObject()
                         throws IOException,
                                AutomationException
The internal ArcObjects IMap object.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBookmarkCount

int getBookmarkCount()
                     throws IOException,
                            AutomationException
The number of bookmarks in the map's bookmark collection.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getBookmarkName

String getBookmarkName(int index)
                       throws IOException,
                              AutomationException
The name of the bookmark.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
index - The index (in)
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

zoomToBookmark

void zoomToBookmark(Object vBookmarkID)
                    throws IOException,
                           AutomationException
Zooms the map display to the bookmark.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
vBookmarkID - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

centerAtBookmark

void centerAtBookmark(Object vBookmarkID)
                      throws IOException,
                             AutomationException
Centers the map display on the bookmark.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
vBookmarkID - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

zoomToFullExtent

void zoomToFullExtent()
                      throws IOException,
                             AutomationException
Zoom to the full extent of all data within the map.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getCustomProperty

Object getCustomProperty()
                         throws IOException,
                                AutomationException
A property to associate data with an object.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

setCustomProperty

void setCustomProperty(Object pVal)
                       throws IOException,
                              AutomationException
A property to associate data with an object.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
pVal - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

searchARFeatures

IARFeatureCursor searchARFeatures(IARSearchDef pSearchDef)
                                  throws IOException,
                                         AutomationException
Searches the map using a search definition and returns an ARFeatureCursor.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
pSearchDef - A reference to a com.esri.arcgis.controls.IARSearchDef (in)
Returns:
A reference to a com.esri.arcgis.controls.IARFeatureCursor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.