com.esri.arcgis.carto
Interface IMapDescriptor

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IMapDescriptorProxy, MapDescriptor

public interface IMapDescriptor
extends java.io.Serializable

COM Interface 'IMapDescriptor'. Generated 3/19/2015 1:20:53 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to the available properties of a map descriptor object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	DISPID_0_GET_NAME
static java.lang.String	DISPID_0_PUT_NAME
static java.lang.String	DISPID_1_GET_NAME
static java.lang.String	DISPID_1_PUT_NAME
static java.lang.String	DISPID_10_GET_NAME
static java.lang.String	DISPID_10_PUT_NAME
static java.lang.String	DISPID_11_GET_NAME
static java.lang.String	DISPID_11_PUT_NAME
static java.lang.String	DISPID_12_GET_NAME
static java.lang.String	DISPID_12_PUT_NAME
static java.lang.String	DISPID_13_GET_NAME
static java.lang.String	DISPID_13_PUT_NAME
static java.lang.String	DISPID_14_NAME
static java.lang.String	DISPID_15_NAME
static java.lang.String	DISPID_16_NAME
static java.lang.String	DISPID_17_NAME
static java.lang.String	DISPID_2_GET_NAME
static java.lang.String	DISPID_2_PUT_NAME
static java.lang.String	DISPID_3_GET_NAME
static java.lang.String	DISPID_3_PUTREF_NAME
static java.lang.String	DISPID_4_GET_NAME
static java.lang.String	DISPID_4_PUT_NAME
static java.lang.String	DISPID_5_GET_NAME
static java.lang.String	DISPID_5_PUT_NAME
static java.lang.String	DISPID_6_GET_NAME
static java.lang.String	DISPID_6_PUT_NAME
static java.lang.String	DISPID_7_GET_NAME
static java.lang.String	DISPID_7_PUT_NAME
static java.lang.String	DISPID_8_GET_NAME
static java.lang.String	DISPID_8_PUT_NAME
static java.lang.String	DISPID_9_GET_NAME
static java.lang.String	DISPID_9_PUT_NAME
static java.lang.String	IID Deprecated. Internal use only
static int	IIDd9609d73_afea_4739_8f29_f5993823f4cf
static int	xxDummy Deprecated. Internal use only

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.
java.lang.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.
java.lang.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(java.lang.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(java.lang.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 %).

Field Detail

IIDd9609d73_afea_4739_8f29_f5993823f4cf

static final int IIDd9609d73_afea_4739_8f29_f5993823f4cf

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

DISPID_0_GET_NAME

static final java.lang.String DISPID_0_GET_NAME

See Also:

Constant Field Values

DISPID_0_PUT_NAME

static final java.lang.String DISPID_0_PUT_NAME

See Also:

Constant Field Values

DISPID_1_GET_NAME

static final java.lang.String DISPID_1_GET_NAME

See Also:

Constant Field Values

DISPID_1_PUT_NAME

static final java.lang.String DISPID_1_PUT_NAME

See Also:

Constant Field Values

DISPID_2_GET_NAME

static final java.lang.String DISPID_2_GET_NAME

See Also:

Constant Field Values

DISPID_2_PUT_NAME

static final java.lang.String DISPID_2_PUT_NAME

See Also:

Constant Field Values

DISPID_3_GET_NAME

static final java.lang.String DISPID_3_GET_NAME

See Also:

Constant Field Values

DISPID_3_PUTREF_NAME

static final java.lang.String DISPID_3_PUTREF_NAME

See Also:

Constant Field Values

DISPID_4_GET_NAME

static final java.lang.String DISPID_4_GET_NAME

See Also:

Constant Field Values

DISPID_4_PUT_NAME

static final java.lang.String DISPID_4_PUT_NAME

See Also:

Constant Field Values

DISPID_5_GET_NAME

static final java.lang.String DISPID_5_GET_NAME

See Also:

Constant Field Values

DISPID_5_PUT_NAME

static final java.lang.String DISPID_5_PUT_NAME

See Also:

Constant Field Values

DISPID_6_GET_NAME

static final java.lang.String DISPID_6_GET_NAME

See Also:

Constant Field Values

DISPID_6_PUT_NAME

static final java.lang.String DISPID_6_PUT_NAME

See Also:

Constant Field Values

DISPID_7_GET_NAME

static final java.lang.String DISPID_7_GET_NAME

See Also:

Constant Field Values

DISPID_7_PUT_NAME

static final java.lang.String DISPID_7_PUT_NAME

See Also:

Constant Field Values

DISPID_8_GET_NAME

static final java.lang.String DISPID_8_GET_NAME

See Also:

Constant Field Values

DISPID_8_PUT_NAME

static final java.lang.String DISPID_8_PUT_NAME

See Also:

Constant Field Values

DISPID_9_GET_NAME

static final java.lang.String DISPID_9_GET_NAME

See Also:

Constant Field Values

DISPID_9_PUT_NAME

static final java.lang.String DISPID_9_PUT_NAME

See Also:

Constant Field Values

DISPID_10_GET_NAME

static final java.lang.String DISPID_10_GET_NAME

See Also:

Constant Field Values

DISPID_10_PUT_NAME

static final java.lang.String DISPID_10_PUT_NAME

See Also:

Constant Field Values

DISPID_11_GET_NAME

static final java.lang.String DISPID_11_GET_NAME

See Also:

Constant Field Values

DISPID_11_PUT_NAME

static final java.lang.String DISPID_11_PUT_NAME

See Also:

Constant Field Values

DISPID_12_GET_NAME

static final java.lang.String DISPID_12_GET_NAME

See Also:

Constant Field Values

DISPID_12_PUT_NAME

static final java.lang.String DISPID_12_PUT_NAME

See Also:

Constant Field Values

DISPID_13_GET_NAME

static final java.lang.String DISPID_13_GET_NAME

See Also:

Constant Field Values

DISPID_13_PUT_NAME

static final java.lang.String DISPID_13_PUT_NAME

See Also:

Constant Field Values

DISPID_14_NAME

static final java.lang.String DISPID_14_NAME

See Also:

Constant Field Values

DISPID_15_NAME

static final java.lang.String DISPID_15_NAME

See Also:

Constant Field Values

DISPID_16_NAME

static final java.lang.String DISPID_16_NAME

See Also:

Constant Field Values

DISPID_17_NAME

static final java.lang.String DISPID_17_NAME

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of the map.

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

The name of the map.

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullExtent

IEnvelope getFullExtent()
                        throws java.io.IOException,
                               AutomationException

The full extent of the map.

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFullExtent

void setFullExtent(IEnvelope extent)
                   throws java.io.IOException,
                          AutomationException

The full extent of the map.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtent

IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException

The current extent of the map.

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtent

void setExtent(IEnvelope extent)
               throws java.io.IOException,
                      AutomationException

The current extent of the map.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException

The spatial reference of the map.

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

void setSpatialReferenceByRef(ISpatialReference spatialReference)
                              throws java.io.IOException,
                                     AutomationException

The spatial reference of the map.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAngle

double getAngle()
                throws java.io.IOException,
                       AutomationException

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

Returns:

The angleDegrees

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAngle

void setAngle(double angleDegrees)
              throws java.io.IOException,
                     AutomationException

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

Parameters:

angleDegrees - The angleDegrees (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayers

IArray getLayers()
                 throws java.io.IOException,
                        AutomationException

The layer descriptors of the map.

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayers

void setLayers(IArray layerDescriptors)
               throws java.io.IOException,
                      AutomationException

The layer descriptors of the map.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerOrder

java.lang.Object getLayerOrder()
                               throws java.io.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.

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayerOrder

void setLayerOrder(java.lang.Object layerIds)
                   throws java.io.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.

Parameters:

layerIds - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomGraphics

IArray getCustomGraphics()
                         throws java.io.IOException,
                                AutomationException

Custom graphics of the map.

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomGraphics

void setCustomGraphics(IArray elements)
                       throws java.io.IOException,
                              AutomationException

Custom graphics of the map.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelBarriers

IGeometryCollection getLabelBarriers()
                                     throws java.io.IOException,
                                            AutomationException

The barriers used for labeling.

Returns:

A reference to a com.esri.arcgis.geometry.IGeometryCollection

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelBarriers

void setLabelBarriers(IGeometryCollection barriers)
                      throws java.io.IOException,
                             AutomationException

The barriers used for labeling.

Parameters:

barriers - A reference to a com.esri.arcgis.geometry.IGeometryCollection (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapScale

double getMapScale()
                   throws java.io.IOException,
                          AutomationException

The scale of the map.

Returns:

The mapScale

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMapScale

void setMapScale(double mapScale)
                 throws java.io.IOException,
                        AutomationException

The scale of the map.

Parameters:

mapScale - The mapScale (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapCenter

IPoint getMapCenter()
                    throws java.io.IOException,
                           AutomationException

The center of the map.

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMapCenter

void setMapCenter(IPoint center)
                  throws java.io.IOException,
                         AutomationException

The center of the map.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isKeepAspectRatio

boolean isKeepAspectRatio()
                          throws java.io.IOException,
                                 AutomationException

Indicates whether of not to maintain the aspect ratio.

Returns:

The keep

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKeepAspectRatio

void setKeepAspectRatio(boolean keep)
                        throws java.io.IOException,
                               AutomationException

Indicates whether of not to maintain the aspect ratio.

Parameters:

keep - The keep (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

IColor getBackgroundColor()
                          throws java.io.IOException,
                                 AutomationException

The background color of the map.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackgroundColor

void setBackgroundColor(IColor color)
                        throws java.io.IOException,
                               AutomationException

The background color of the map.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTransparentColor

IColor getTransparentColor()
                           throws java.io.IOException,
                                  AutomationException

The color used for transparency (100 %).

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransparentColor

void setTransparentColor(IColor color)
                         throws java.io.IOException,
                                AutomationException

The color used for transparency (100 %).

Parameters:

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

Throws:

java.io.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 java.io.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.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearMapSurrounds

void clearMapSurrounds()
                       throws java.io.IOException,
                              AutomationException

Remove all surrounds from the map.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addPixelGraphic

void addPixelGraphic(IElement graphic)
                     throws java.io.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.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearPixelGraphics

void clearPixelGraphics()
                        throws java.io.IOException,
                               AutomationException

Remove all pixel graphics from the map.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.