com.esri.arcgis.carto
Interface IMapDescription

All Superinterfaces:

Serializable

All Known Implementing Classes:

MapDescription

public interface IMapDescription
extends Serializable

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

Superseded By

IMapDescription2

Product Availability

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

Method Summary

IGraphicElements	getCustomGraphics() Custom graphics.
ILayerDescriptions	getLayerDescriptions() A collection of Layer Description objects, each describing a layer within the map (data frame).
IMapArea	getMapArea() The display area of the map (data frame).
double	getMapRotation() The angle/rotation of the map (data frame) in degrees, measured anti-clockwise.
String	getName() The name of the map (data frame).
IColor	getSelectionColor() The default selection color.
ISpatialReference	getSpatialReference() The spatial reference of the map (data frame).
IColor	getTransparentColor() The color that is transparent (100 %).
void	setCustomGraphics(IGraphicElements elements) Custom graphics.
void	setLayerDescriptions(ILayerDescriptions layerDescriptions) A collection of Layer Description objects, each describing a layer within the map (data frame).
void	setMapArea(IMapArea area) The display area of the map (data frame).
void	setMapRotation(double angleDegrees) The angle/rotation of the map (data frame) in degrees, measured anti-clockwise.
void	setName(String name) The name of the map (data frame).
void	setSelectionColor(IColor color) The default selection color.
void	setSpatialReferenceByRef(ISpatialReference spatialReference) The spatial reference of the map (data frame).
void	setTransparentColor(IColor color) The color that is transparent (100 %).

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

The name of the map (data frame).

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 (data frame).

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.

getMapArea

IMapArea getMapArea()
                    throws IOException,
                           AutomationException

The display area of the map (data frame).

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMapArea

void setMapArea(IMapArea area)
                throws IOException,
                       AutomationException

The display area of the map (data frame).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

area - A reference to a com.esri.arcgis.carto.IMapArea (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerDescriptions

ILayerDescriptions getLayerDescriptions()
                                        throws IOException,
                                               AutomationException

A collection of Layer Description objects, each describing a layer within the map (data frame).

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayerDescriptions

void setLayerDescriptions(ILayerDescriptions layerDescriptions)
                          throws IOException,
                                 AutomationException

A collection of Layer Description objects, each describing a layer within the map (data frame).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

layerDescriptions - A reference to a com.esri.arcgis.carto.ILayerDescriptions (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapRotation

double getMapRotation()
                      throws IOException,
                             AutomationException

The angle/rotation of the map (data frame) 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.

setMapRotation

void setMapRotation(double angleDegrees)
                    throws IOException,
                           AutomationException

The angle/rotation of the map (data frame) 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.

getSpatialReference

ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException

The spatial reference of the map (data frame).

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 (data frame).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

getCustomGraphics

IGraphicElements getCustomGraphics()
                                   throws IOException,
                                          AutomationException

Custom graphics.

Remarks

Use CustomGraphics to display text or geometric shapes on the map. When interacting with the display of labels, CustomGraphics will honor the Feature Weight value for the default graphics layer set in the Label Weight Ranking dialog in the map document. A setting of High, the ArcMap default, will result in labels not drawing within the bounds of the custom graphics. If the Feature Weight for the default graphics layer is None, Low or Medium labels will draw within the bounds of the custom graphics. With None, all labels should display. With Low or Medium, the amount of labels that draw may vary.

Please note that the optimized MapServer only supports the esriSFSSolid style of ISimpleFillSymbol. For other types of fills, use other fill symbol types such as ILineSymbol. For hollow symbols, you should use IColor::NullColor with esriSFSSolid instead of using the esriSFSNull style.

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomGraphics

void setCustomGraphics(IGraphicElements elements)
                       throws IOException,
                              AutomationException

Custom graphics.

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.carto.IGraphicElements (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTransparentColor

IColor getTransparentColor()
                           throws IOException,
                                  AutomationException

The color that is transparent (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 that is transparent (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.

getSelectionColor

IColor getSelectionColor()
                         throws IOException,
                                AutomationException

The default selection 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.

setSelectionColor

void setSelectionColor(IColor color)
                       throws IOException,
                              AutomationException

The default selection color.

Product Availability

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

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.