com.esri.arcgis.carto
Interface IMapInset

All Superinterfaces:

IMapSurround, Serializable

All Known Implementing Classes:

ImageInset, MapInset

public interface IMapInset
extends IMapSurround, Serializable

Provides access to members that control the inset map surrounds.

Superseded By

IMapInset2

Product Availability

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

Method Summary

void	calculateVisibleBounds() Calculates the visible bounds by applying the zoom or scale parameter to MapBounds (used when snapshot is false).
String	getDescription() Description reflecting the current settings of the MapInset.
IEnvelope	getMapBounds() The relative position of the inset to the associated map (used when the inset is live).
IEnvelope	getVisibleBounds() The map extent shown by the inset (used when the inset is not live).
double	getZoomPercent() Zoom amount as a percentage.
double	getZoomScale() The zoom amount as an absolute Scale (i.e., 1:20000).
boolean	isLive() Indicates if the inset shows a live view of the underlying map.
boolean	isUsingZoomScale() Indicates if ZoomScale or ZoomPercent is being used.
void	setIsLive(boolean isLive) Indicates if the inset shows a live view of the underlying map.
void	setMapBounds(IEnvelope bounds) The relative position of the inset to the associated map (used when the inset is live).
void	setVisibleBounds(IEnvelope visibleBounds) The map extent shown by the inset (used when the inset is not live).
void	setZoomPercent(double percent) Zoom amount as a percentage.
void	setZoomScale(double scale) The zoom amount as an absolute Scale (i.e., 1:20000).

Methods inherited from interface com.esri.arcgis.carto.IMapSurround

delayEvents, draw, fitToBounds, getIcon, getMap, getName, queryBounds, refresh, setMapByRef, setName

Method Detail

getMapBounds

IEnvelope getMapBounds()
                       throws IOException,
                              AutomationException

The relative position of the inset to the associated map (used when the inset is live). The zoom amount is applied to this rectangle to determine the visible bounds that is actually drawn.

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.

setMapBounds

void setMapBounds(IEnvelope bounds)
                  throws IOException,
                         AutomationException

The relative position of the inset to the associated map (used when the inset is live). The zoom amount is applied to this rectangle to determine the visible bounds that is actually drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

getVisibleBounds

IEnvelope getVisibleBounds()
                           throws IOException,
                                  AutomationException

The map extent shown by the inset (used when the inset is not live).

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.

setVisibleBounds

void setVisibleBounds(IEnvelope visibleBounds)
                      throws IOException,
                             AutomationException

The map extent shown by the inset (used when the inset is not live).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

isLive

boolean isLive()
               throws IOException,
                      AutomationException

Indicates if the inset shows a live view of the underlying map. False means a snapshot of the underlying map is taken at the time the flag is changed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The isLive

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsLive

void setIsLive(boolean isLive)
               throws IOException,
                      AutomationException

Indicates if the inset shows a live view of the underlying map. False means a snapshot of the underlying map is taken at the time the flag is changed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

isLive - The isLive (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUsingZoomScale

boolean isUsingZoomScale()
                         throws IOException,
                                AutomationException

Indicates if ZoomScale or ZoomPercent is being used. The one specified last is being used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The usingZoomScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZoomPercent

double getZoomPercent()
                      throws IOException,
                             AutomationException

Zoom amount as a percentage. 100 means show the underlying map at normal size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The percent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZoomPercent

void setZoomPercent(double percent)
                    throws IOException,
                           AutomationException

Zoom amount as a percentage. 100 means show the underlying map at normal size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

percent - The percent (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZoomScale

double getZoomScale()
                    throws IOException,
                           AutomationException

The zoom amount as an absolute Scale (i.e., 1:20000).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The scale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZoomScale

void setZoomScale(double scale)
                  throws IOException,
                         AutomationException

The zoom amount as an absolute Scale (i.e., 1:20000).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

scale - The scale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

String getDescription()
                      throws IOException,
                             AutomationException

Description reflecting the current settings of the MapInset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The title

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

calculateVisibleBounds

void calculateVisibleBounds()
                            throws IOException,
                                   AutomationException

Calculates the visible bounds by applying the zoom or scale parameter to MapBounds (used when snapshot is false).

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.