com.esri.arcgis.carto
Interface IMapTimeDisplay

All Superinterfaces:

Serializable

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() computeFullTimeExtent
ITimeExtent	getCurrentTimeExtent() getCurrentTimeExtent
double	getDefaultTimeInterval() getDefaultTimeInterval
int	getDefaultTimeIntervalUnits() getDefaultTimeIntervalUnits
double	getDefaultTimeWindow() getDefaultTimeWindow
String	getDisplayDateFormat() getDisplayDateFormat
int	getDisplaySpeed() getDisplaySpeed
String	getDisplayTimeFormat() getDisplayTimeFormat
ITimeExtent	getFullTimeExtent() getFullTimeExtent
int	getPlayOption() getPlayOption
ILayer	getTimeExtentDefinitionLayer() getTimeExtentDefinitionLayer
int	getTimeExtentOption() getTimeExtentOption
ITimeReference	getTimeReference() getTimeReference
ITimeValue	getTimeValue() getTimeValue
boolean	hasTimeData() hasTimeData
boolean	isDisplayEachTimestamp() isDisplayEachTimestamp
boolean	isDynamicTimeRefresh() isDynamicTimeRefresh
boolean	isShowTime() isShowTime
void	setCurrentTimeExtentByRef(ITimeExtent timeExtent) setCurrentTimeExtentByRef
void	setDefaultTimeInterval(double interval) setDefaultTimeInterval
void	setDefaultTimeIntervalUnits(int units) setDefaultTimeIntervalUnits
void	setDefaultTimeWindow(double duration) setDefaultTimeWindow
void	setDisplayDateFormat(String dateFormat) setDisplayDateFormat
void	setDisplayEachTimestamp(boolean value) setDisplayEachTimestamp
void	setDisplaySpeed(int speed) setDisplaySpeed
void	setDisplayTimeFormat(String timeFormat) setDisplayTimeFormat
void	setDynamicTimeRefresh(boolean flag) setDynamicTimeRefresh
void	setFullTimeExtentByRef(ITimeExtent timeExtent) setFullTimeExtentByRef
void	setPlayOption(int option) setPlayOption
void	setShowTime(boolean flag) setShowTime
void	setTimeExtentDefinitionLayerByRef(ILayer layer) setTimeExtentDefinitionLayerByRef
void	setTimeExtentOption(int option) setTimeExtentOption
void	setTimeReferenceByRef(ITimeReference timeReference) setTimeReferenceByRef
void	setTimeValueByRef(ITimeValue time) setTimeValueByRef

Method Detail

hasTimeData

boolean hasTimeData()
                    throws IOException,
                           AutomationException

hasTimeData

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

getDefaultTimeInterval

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

setDefaultTimeInterval

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

getDefaultTimeIntervalUnits

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

setDefaultTimeIntervalUnits

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

getDefaultTimeWindow

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

setDefaultTimeWindow

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

getFullTimeExtent

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

setFullTimeExtentByRef

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

getCurrentTimeExtent

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

setCurrentTimeExtentByRef

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

getTimeValue

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

setTimeValueByRef

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

getTimeReference

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

setTimeReferenceByRef

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

getDisplayDateFormat

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

setDisplayDateFormat

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

getDisplayTimeFormat

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

setDisplayTimeFormat

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

isDisplayEachTimestamp

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

setDisplayEachTimestamp

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

getDisplaySpeed

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

setDisplaySpeed

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

getPlayOption

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

setPlayOption

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

getTimeExtentOption

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

setTimeExtentOption

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

getTimeExtentDefinitionLayer

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

setTimeExtentDefinitionLayerByRef

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

isDynamicTimeRefresh

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

setDynamicTimeRefresh

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

isShowTime

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

setShowTime

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

computeFullTimeExtent

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.