com.esri.arcgis.carto
Interface IMapTimeDisplay2

All Superinterfaces:

IMapTimeDisplay, Serializable

All Known Implementing Classes:

Globe, Map, Scene

public interface IMapTimeDisplay2
extends IMapTimeDisplay, Serializable

Provides access to members that control the current time on the map.

Product Availability

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

Method Summary

int	getTimeRelation() Time relation used with the time window for the map.
boolean	isHasLiveData() Indicates whether the map has a time-enabled layer that is being updated frequently with new data.
boolean	isShowTimeOnDisplay() Indicates whether time is displayed on the map.
void	setHasLiveData(boolean flag) Indicates whether the map has a time-enabled layer that is being updated frequently with new data.
void	setShowTimeOnDisplay(boolean flag) Indicates whether time is displayed on the map.
void	setTimeRelation(int relation) Time relation used with the time window for the map.

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

computeFullTimeExtent, getCurrentTimeExtent, getDefaultTimeInterval, getDefaultTimeIntervalUnits, getDefaultTimeWindow, getDisplayDateFormat, getDisplaySpeed, getDisplayTimeFormat, getFullTimeExtent, getPlayOption, getTimeExtentDefinitionLayer, getTimeExtentOption, getTimeReference, getTimeValue, hasTimeData, isDisplayEachTimestamp, isDynamicTimeRefresh, isShowTime, setCurrentTimeExtentByRef, setDefaultTimeInterval, setDefaultTimeIntervalUnits, setDefaultTimeWindow, setDisplayDateFormat, setDisplayEachTimestamp, setDisplaySpeed, setDisplayTimeFormat, setDynamicTimeRefresh, setFullTimeExtentByRef, setPlayOption, setShowTime, setTimeExtentDefinitionLayerByRef, setTimeExtentOption, setTimeReferenceByRef, setTimeValueByRef

Method Detail

isHasLiveData

boolean isHasLiveData()
                      throws IOException,
                             AutomationException

Indicates whether the map has a time-enabled layer that is being updated frequently with new data.

Product Availability

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

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHasLiveData

void setHasLiveData(boolean flag)
                    throws IOException,
                           AutomationException

Indicates whether the map has a time-enabled layer that is being updated frequently with new data.

Product Availability

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

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeRelation

int getTimeRelation()
                    throws IOException,
                           AutomationException

Time relation used with the time window for the map.

Product Availability

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

Returns:

A com.esri.arcgis.system.esriTimeRelation constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeRelation

void setTimeRelation(int relation)
                     throws IOException,
                            AutomationException

Time relation used with the time window for the map.

Product Availability

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

Parameters:

relation - A com.esri.arcgis.system.esriTimeRelation constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowTimeOnDisplay

boolean isShowTimeOnDisplay()
                            throws IOException,
                                   AutomationException

Indicates whether time is displayed on the map.

Product Availability

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

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowTimeOnDisplay

void setShowTimeOnDisplay(boolean flag)
                          throws IOException,
                                 AutomationException

Indicates whether time is displayed on the map.

Product Availability

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

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.