com.esri.arcgis.carto
Interface IMapTimeDisplay

All Superinterfaces:

Serializable

All Known Subinterfaces:

IMapTimeDisplay2

All Known Implementing Classes:

Globe, Map, Scene

public interface IMapTimeDisplay
extends 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

ITimeExtent	computeFullTimeExtent() Returns the full time extent of the time-enabled layers in the map.
ITimeExtent	getCurrentTimeExtent() The current time extent of the map.
double	getDefaultTimeInterval() The time interval to be used by the time slider to animate the map.
int	getDefaultTimeIntervalUnits() The time interval units to be used to animate the map.
double	getDefaultTimeWindow() The time window used to display the data in the map.
String	getDisplayDateFormat() The format of the date that is displayed on the time slider.
int	getDisplaySpeed() The speed of the slider on a scale of 1 to 10 with 10 being the fastest.
String	getDisplayTimeFormat() The format of the time that is displayed on the time slider.
ITimeExtent	getFullTimeExtent() Returns the full time extent of the time-enabled layers in the map.
int	getPlayOption() The play option (Stop, Reverse, Repeat) used by the slider after the time visualization has been played once.
ILayer	getTimeExtentDefinitionLayer() The time-enabled layer that defines the time extent of the map.
int	getTimeExtentOption() Indicates how the time extent of the map is defined.
ITimeReference	getTimeReference() The time reference (time zone information, daylight savings, etc.) associated with the map.
ITimeValue	getTimeValue() The time extent for which the data is displayed in the map.
boolean	hasTimeData() Indicates whether the map has a time-enabled layer.
boolean	isDisplayEachTimestamp() Indicates whether data for each timestamp will be drawn when playing the time visualization.
boolean	isDynamicTimeRefresh() Indicates whether the data in the map refreshes when moving the time slider dynamically.
boolean	isShowTime() Indicates whether time is enabled on the map.
void	setCurrentTimeExtentByRef(ITimeExtent timeExtent) The current time extent of the map.
void	setDefaultTimeInterval(double interval) The time interval to be used by the time slider to animate the map.
void	setDefaultTimeIntervalUnits(int units) The time interval units to be used to animate the map.
void	setDefaultTimeWindow(double duration) The time window used to display the data in the map.
void	setDisplayDateFormat(String dateFormat) The format of the date that is displayed on the time slider.
void	setDisplayEachTimestamp(boolean value) Indicates whether data for each timestamp will be drawn when playing the time visualization.
void	setDisplaySpeed(int speed) The speed of the slider on a scale of 1 to 10 with 10 being the fastest.
void	setDisplayTimeFormat(String timeFormat) The format of the time that is displayed on the time slider.
void	setDynamicTimeRefresh(boolean flag) Indicates whether the data in the map refreshes when moving the time slider dynamically.
void	setFullTimeExtentByRef(ITimeExtent timeExtent) Returns the full time extent of the time-enabled layers in the map.
void	setPlayOption(int option) The play option (Stop, Reverse, Repeat) used by the slider after the time visualization has been played once.
void	setShowTime(boolean flag) Indicates whether time is enabled on the map.
void	setTimeExtentDefinitionLayerByRef(ILayer layer) The time-enabled layer that defines the time extent of the map.
void	setTimeExtentOption(int option) Indicates how the time extent of the map is defined.
void	setTimeReferenceByRef(ITimeReference timeReference) The time reference (time zone information, daylight savings, etc.) associated with the map.
void	setTimeValueByRef(ITimeValue time) The time extent for which the data is displayed in the map.

Method Detail

hasTimeData

boolean hasTimeData()
                    throws IOException,
                           AutomationException

Indicates whether the map has a time-enabled layer.

Product Availability

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

Returns:

The hasTimeData

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultTimeInterval

double getDefaultTimeInterval()
                              throws IOException,
                                     AutomationException

The time interval to be used by the time slider to animate the map.

Product Availability

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

Returns:

The interval

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultTimeInterval

void setDefaultTimeInterval(double interval)
                            throws IOException,
                                   AutomationException

The time interval to be used by the time slider to animate the map.

Product Availability

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

Parameters:

interval - The interval (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultTimeIntervalUnits

int getDefaultTimeIntervalUnits()
                                throws IOException,
                                       AutomationException

The time interval units to be used to animate the map.

Product Availability

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

Returns:

A com.esri.arcgis.system.esriTimeUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultTimeIntervalUnits

void setDefaultTimeIntervalUnits(int units)
                                 throws IOException,
                                        AutomationException

The time interval units to be used to animate the map.

Product Availability

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

Parameters:

units - A com.esri.arcgis.system.esriTimeUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultTimeWindow

double getDefaultTimeWindow()
                            throws IOException,
                                   AutomationException

The time window used to display the data in the map.

Product Availability

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

Returns:

The duration

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultTimeWindow

void setDefaultTimeWindow(double duration)
                          throws IOException,
                                 AutomationException

The time window used to display the data in the map.

Product Availability

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

Parameters:

duration - The duration (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullTimeExtent

ITimeExtent getFullTimeExtent()
                              throws IOException,
                                     AutomationException

Returns the full time extent of the time-enabled layers in the map.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFullTimeExtentByRef

void setFullTimeExtentByRef(ITimeExtent timeExtent)
                            throws IOException,
                                   AutomationException

Returns the full time extent of the time-enabled layers in the map.

Product Availability

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

Parameters:

timeExtent - A reference to a com.esri.arcgis.system.ITimeExtent (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentTimeExtent

ITimeExtent getCurrentTimeExtent()
                                 throws IOException,
                                        AutomationException

The current time extent of the map.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentTimeExtentByRef

void setCurrentTimeExtentByRef(ITimeExtent timeExtent)
                               throws IOException,
                                      AutomationException

The current time extent of the map.

Product Availability

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

Parameters:

timeExtent - A reference to a com.esri.arcgis.system.ITimeExtent (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeValue

ITimeValue getTimeValue()
                        throws IOException,
                               AutomationException

The time extent for which the data is displayed in the map.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeValueByRef

void setTimeValueByRef(ITimeValue time)
                       throws IOException,
                              AutomationException

The time extent for which the data is displayed in the map.

Product Availability

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

Parameters:

time - A reference to a com.esri.arcgis.system.ITimeValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeReference

ITimeReference getTimeReference()
                                throws IOException,
                                       AutomationException

The time reference (time zone information, daylight savings, etc.) associated with the map.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeReferenceByRef

void setTimeReferenceByRef(ITimeReference timeReference)
                           throws IOException,
                                  AutomationException

The time reference (time zone information, daylight savings, etc.) associated with the map.

Product Availability

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

Parameters:

timeReference - A reference to a com.esri.arcgis.system.ITimeReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayDateFormat

String getDisplayDateFormat()
                            throws IOException,
                                   AutomationException

The format of the date that is displayed on the time slider.

Product Availability

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

Returns:

The dateFormat

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayDateFormat

void setDisplayDateFormat(String dateFormat)
                          throws IOException,
                                 AutomationException

The format of the date that is displayed on the time slider.

Product Availability

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

Parameters:

dateFormat - The dateFormat (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayTimeFormat

String getDisplayTimeFormat()
                            throws IOException,
                                   AutomationException

The format of the time that is displayed on the time slider.

Product Availability

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

Returns:

The timeFormat

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayTimeFormat

void setDisplayTimeFormat(String timeFormat)
                          throws IOException,
                                 AutomationException

The format of the time that is displayed on the time slider.

Product Availability

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

Parameters:

timeFormat - The timeFormat (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDisplayEachTimestamp

boolean isDisplayEachTimestamp()
                               throws IOException,
                                      AutomationException

Indicates whether data for each timestamp will be drawn when playing the time visualization.

Product Availability

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

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayEachTimestamp

void setDisplayEachTimestamp(boolean value)
                             throws IOException,
                                    AutomationException

Indicates whether data for each timestamp will be drawn when playing the time visualization.

Product Availability

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

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplaySpeed

int getDisplaySpeed()
                    throws IOException,
                           AutomationException

The speed of the slider on a scale of 1 to 10 with 10 being the fastest.

Product Availability

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

Returns:

The speed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplaySpeed

void setDisplaySpeed(int speed)
                     throws IOException,
                            AutomationException

The speed of the slider on a scale of 1 to 10 with 10 being the fastest.

Product Availability

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

Parameters:

speed - The speed (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPlayOption

int getPlayOption()
                  throws IOException,
                         AutomationException

The play option (Stop, Reverse, Repeat) used by the slider after the time visualization has been played once.

Product Availability

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

Returns:

A com.esri.arcgis.carto.esriMapTimePlayOption constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPlayOption

void setPlayOption(int option)
                   throws IOException,
                          AutomationException

The play option (Stop, Reverse, Repeat) used by the slider after the time visualization has been played once.

Product Availability

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

Parameters:

option - A com.esri.arcgis.carto.esriMapTimePlayOption constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeExtentOption

int getTimeExtentOption()
                        throws IOException,
                               AutomationException

Indicates how the time extent of the map is defined.

Product Availability

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

Returns:

A com.esri.arcgis.carto.esriMapTimeExtentOption constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeExtentOption

void setTimeExtentOption(int option)
                         throws IOException,
                                AutomationException

Indicates how the time extent of the map is defined.

Product Availability

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

Parameters:

option - A com.esri.arcgis.carto.esriMapTimeExtentOption constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeExtentDefinitionLayer

ILayer getTimeExtentDefinitionLayer()
                                    throws IOException,
                                           AutomationException

The time-enabled layer that defines the time extent of the map.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.carto.ILayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeExtentDefinitionLayerByRef

void setTimeExtentDefinitionLayerByRef(ILayer layer)
                                       throws IOException,
                                              AutomationException

The time-enabled layer that defines the time extent of the map.

Product Availability

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

Parameters:

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDynamicTimeRefresh

boolean isDynamicTimeRefresh()
                             throws IOException,
                                    AutomationException

Indicates whether the data in the map refreshes when moving the time slider dynamically.

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.

setDynamicTimeRefresh

void setDynamicTimeRefresh(boolean flag)
                           throws IOException,
                                  AutomationException

Indicates whether the data in the map refreshes when moving the time slider dynamically.

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.

isShowTime

boolean isShowTime()
                   throws IOException,
                          AutomationException

Indicates whether time is enabled 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.

setShowTime

void setShowTime(boolean flag)
                 throws IOException,
                        AutomationException

Indicates whether time is enabled 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.

computeFullTimeExtent

ITimeExtent computeFullTimeExtent()
                                  throws IOException,
                                         AutomationException

Returns the full time extent of the time-enabled layers in the map.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.