com.esri.arcgis.carto
Interface IMapDescriptor

All Superinterfaces:

Serializable

All Known Implementing Classes:

MapDescriptor

public interface IMapDescriptor
extends Serializable

Provides access to the available properties of a map descriptor object.

Product Availability

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

Method Summary

void	addMapSurround(IMapSurround surround, int xPixelOrigin, int yPixelOrigin, int anchorPoint) Call this multiple times to place surrounds on the surface of the map.
void	addPixelGraphic(IElement graphic) Call this multiple times to place graphics in pixel space on the map above Custom Graphics and Map Surrounds.
void	clearMapSurrounds() Remove all surrounds from the map.
void	clearPixelGraphics() Remove all pixel graphics from the map.
double	getAngle() The angle/rotation of the map in degrees, measured anti-clockwise.
IColor	getBackgroundColor() The background color of the map.
IArray	getCustomGraphics() Custom graphics of the map.
IEnvelope	getExtent() The current extent of the map.
IEnvelope	getFullExtent() The full extent of the map.
IGeometryCollection	getLabelBarriers() The barriers used for labeling.
Object	getLayerOrder() The layer order for the map.
IArray	getLayers() The layer descriptors of the map.
IPoint	getMapCenter() The center of the map.
double	getMapScale() The scale of the map.
String	getName() The name of the map.
ISpatialReference	getSpatialReference() The spatial reference of the map.
IColor	getTransparentColor() The color used for transparency (100 %).
boolean	isKeepAspectRatio() Indicates whether of not to maintain the aspect ratio.
void	setAngle(double angleDegrees) The angle/rotation of the map in degrees, measured anti-clockwise.
void	setBackgroundColor(IColor color) The background color of the map.
void	setCustomGraphics(IArray elements) Custom graphics of the map.
void	setExtent(IEnvelope extent) The current extent of the map.
void	setFullExtent(IEnvelope extent) The full extent of the map.
void	setKeepAspectRatio(boolean keep) Indicates whether of not to maintain the aspect ratio.
void	setLabelBarriers(IGeometryCollection barriers) The barriers used for labeling.
void	setLayerOrder(Object layerIds) The layer order for the map.
void	setLayers(IArray layerDescriptors) The layer descriptors of the map.
void	setMapCenter(IPoint center) The center of the map.
void	setMapScale(double mapScale) The scale of the map.
void	setName(String name) The name of the map.
void	setSpatialReferenceByRef(ISpatialReference spatialReference) The spatial reference of the map.
void	setTransparentColor(IColor color) The color used for transparency (100 %).

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

The name of the map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String name)
             throws IOException,
                    AutomationException

The name of the map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullExtent

IEnvelope getFullExtent()
                        throws IOException,
                               AutomationException

The full extent of the 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.geometry.IEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFullExtent

void setFullExtent(IEnvelope extent)
                   throws IOException,
                          AutomationException

The full extent of the map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

getExtent

IEnvelope getExtent()
                    throws IOException,
                           AutomationException

The current extent of the 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.geometry.IEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtent

void setExtent(IEnvelope extent)
               throws IOException,
                      AutomationException

The current extent of the map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

getSpatialReference

ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException

The spatial reference of the 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.geometry.ISpatialReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

void setSpatialReferenceByRef(ISpatialReference spatialReference)
                              throws IOException,
                                     AutomationException

The spatial reference of the map.

Product Availability

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

Parameters:

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

getAngle

double getAngle()
                throws IOException,
                       AutomationException

The angle/rotation of the map in degrees, measured anti-clockwise.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The angleDegrees

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAngle

void setAngle(double angleDegrees)
              throws IOException,
                     AutomationException

The angle/rotation of the map in degrees, measured anti-clockwise.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

angleDegrees - The angleDegrees (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayers

IArray getLayers()
                 throws IOException,
                        AutomationException

The layer descriptors of the 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.system.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayers

void setLayers(IArray layerDescriptors)
               throws IOException,
                      AutomationException

The layer descriptors of the map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

layerDescriptors - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerOrder

Object getLayerOrder()
                     throws IOException,
                            AutomationException

The layer order for the map. The VARIANT value is a SAFEARRAY of long integers that list the layerIDs in order. The first element is top layer in the map. Layers that are within groups are not listed in this array.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayerOrder

void setLayerOrder(Object layerIds)
                   throws IOException,
                          AutomationException

The layer order for the map. The VARIANT value is a SAFEARRAY of long integers that list the layerIDs in order. The first element is top layer in the map. Layers that are within groups are not listed in this array.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

layerIds - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomGraphics

IArray getCustomGraphics()
                         throws IOException,
                                AutomationException

Custom graphics of the 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.system.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomGraphics

void setCustomGraphics(IArray elements)
                       throws IOException,
                              AutomationException

Custom graphics of the map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

elements - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelBarriers

IGeometryCollection getLabelBarriers()
                                     throws IOException,
                                            AutomationException

The barriers used for labeling.

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelBarriers

void setLabelBarriers(IGeometryCollection barriers)
                      throws IOException,
                             AutomationException

The barriers used for labeling.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

barriers - A reference to a com.esri.arcgis.geometry.IGeometryCollection (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.

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.

setMapScale

void setMapScale(double mapScale)
                 throws IOException,
                        AutomationException

The scale of the map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

mapScale - The mapScale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapCenter

IPoint getMapCenter()
                    throws IOException,
                           AutomationException

The center of the 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.geometry.IPoint

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMapCenter

void setMapCenter(IPoint center)
                  throws IOException,
                         AutomationException

The center of the map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

center - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isKeepAspectRatio

boolean isKeepAspectRatio()
                          throws IOException,
                                 AutomationException

Indicates whether of not to maintain the aspect ratio.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The keep

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKeepAspectRatio

void setKeepAspectRatio(boolean keep)
                        throws IOException,
                               AutomationException

Indicates whether of not to maintain the aspect ratio.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

keep - The keep (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

IColor getBackgroundColor()
                          throws IOException,
                                 AutomationException

The background color of the 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.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 of the map.

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 color used for transparency (100 %).

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 color used for transparency (100 %).

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.

addMapSurround

void addMapSurround(IMapSurround surround,
                    int xPixelOrigin,
                    int yPixelOrigin,
                    int anchorPoint)
                    throws IOException,
                           AutomationException

Call this multiple times to place surrounds on the surface of the map. Specify coordinates in pixels. Origin is at lower left corner.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

surround - A reference to a com.esri.arcgis.carto.IMapSurround (in)

xPixelOrigin - The xPixelOrigin (in)

yPixelOrigin - The yPixelOrigin (in)

anchorPoint - A com.esri.arcgis.carto.esriAnchorPointEnum constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearMapSurrounds

void clearMapSurrounds()
                       throws IOException,
                              AutomationException

Remove all surrounds from the map.

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.

addPixelGraphic

void addPixelGraphic(IElement graphic)
                     throws IOException,
                            AutomationException

Call this multiple times to place graphics in pixel space on the map above Custom Graphics and Map Surrounds. Specify coordinates in pixels. Origin is at lower left corner.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

graphic - A reference to a com.esri.arcgis.carto.IElement (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearPixelGraphics

void clearPixelGraphics()
                        throws IOException,
                               AutomationException

Remove all pixel graphics from the map.

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.