com.esri.arcgis.carto
Interface IDynamicMap

All Superinterfaces:

Serializable

All Known Implementing Classes:

Map

public interface IDynamicMap
extends Serializable

Provides access to dynamic display.

Description

The IDynamicMap interface allows to toggle between Dynamic and Standard mode, as well as to control some properties of the dynamic mode.

Product Availability

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

Method Summary

int	getDynamicDrawRate() The Dynamic draw rate in milliseconds.
boolean	isDynamicMapEnabled() Indicates if dynamic map is turned on or off.
boolean	isUseSubPixelRendering() Indicates whether the dynamic map is rendered in Sub Pixels or Full Pixels (snap to the nearest discrete pixel).
void	setDynamicDrawRate(int dynamicDrawRateMS) The Dynamic draw rate in milliseconds.
void	setDynamicMapEnabled(boolean isEnable) Indicates if dynamic map is turned on or off.
void	setUseSubPixelRendering(boolean useSubPixelRendering) Indicates whether the dynamic map is rendered in Sub Pixels or Full Pixels (snap to the nearest discrete pixel).

Method Detail

isDynamicMapEnabled

boolean isDynamicMapEnabled()
                            throws IOException,
                                   AutomationException

Indicates if dynamic map is turned on or off.

Remarks

Use the DynamicMapEnabled property to toggle between Dynamic and Standard mode.

When true the Map is in Dynamic Mode (Dynamic Display is Active), when false the Map is in Standard Mode (Dynamic Display is Deactivated).

Product Availability

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

Returns:

The isEnable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDynamicMapEnabled

void setDynamicMapEnabled(boolean isEnable)
                          throws IOException,
                                 AutomationException

Indicates if dynamic map is turned on or off.

Remarks

Use the DynamicMapEnabled property to toggle between Dynamic and Standard mode.

When true the Map is in Dynamic Mode (Dynamic Display is Active), when false the Map is in Standard Mode (Dynamic Display is Deactivated).

Product Availability

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

Parameters:

isEnable - The isEnable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDynamicDrawRate

int getDynamicDrawRate()
                       throws IOException,
                              AutomationException

The Dynamic draw rate in milliseconds.

Remarks

The DynamicDrawRate property controls the heart-beat rate of the Dynamic Map. The rate value refers to the Dynamic Map cycle time in milliseconds. If this value is changed to be slower, everything in dynamic mode will respond slower.

Product Availability

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

Returns:

The dynamicDrawRateMS

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDynamicDrawRate

void setDynamicDrawRate(int dynamicDrawRateMS)
                        throws IOException,
                               AutomationException

The Dynamic draw rate in milliseconds.

Remarks

The DynamicDrawRate property controls the heart-beat rate of the Dynamic Map. The rate value refers to the Dynamic Map cycle time in milliseconds. If this value is changed to be slower, everything in dynamic mode will respond slower.

Product Availability

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

Parameters:

dynamicDrawRateMS - The dynamicDrawRateMS (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseSubPixelRendering

boolean isUseSubPixelRendering()
                               throws IOException,
                                      AutomationException

Indicates whether the dynamic map is rendered in Sub Pixels or Full Pixels (snap to the nearest discrete pixel).

Remarks

When true, the Dynamic Map will render in Sub Pixel units. That enables the map and the Dynamic Elements to navigate smoothly, while accurately converting map coordinates to floating point screen pixel coordinates. This method might cause some blurriness.

When false, the Dynamic Map will render in Full Pixel units. That will result in snapping the Map and the Dynamic Elements to the nearest discrete screen pixel coordinate.

Product Availability

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

Returns:

The useSubPixelRendering

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseSubPixelRendering

void setUseSubPixelRendering(boolean useSubPixelRendering)
                             throws IOException,
                                    AutomationException

Indicates whether the dynamic map is rendered in Sub Pixels or Full Pixels (snap to the nearest discrete pixel).

Remarks

When true, the Dynamic Map will render in Sub Pixel units. That enables the map and the Dynamic Elements to navigate smoothly, while accurately converting map coordinates to floating point screen pixel coordinates. This method might cause some blurriness.

When false, the Dynamic Map will render in Full Pixel units. That will result in snapping the Map and the Dynamic Elements to the nearest discrete screen pixel coordinate.

Product Availability

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

Parameters:

useSubPixelRendering - The useSubPixelRendering (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.