com.esri.arcgis.carto
Interface IMapTimeDisplay

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IMapTimeDisplay2

All Known Implementing Classes:

Globe, IMapTimeDisplay2Proxy, IMapTimeDisplayProxy, Map, Scene

public interface IMapTimeDisplay
extends java.io.Serializable

COM Interface 'IMapTimeDisplay'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that control the current time on the map.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID54bc9b6f_3a81_48d0_a07c_52238b28dc7a
static int	xxDummy Deprecated. Internal use only

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.
java.lang.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.
java.lang.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(java.lang.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(java.lang.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.

Field Detail

IID54bc9b6f_3a81_48d0_a07c_52238b28dc7a

static final int IID54bc9b6f_3a81_48d0_a07c_52238b28dc7a

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

hasTimeData

boolean hasTimeData()
                    throws java.io.IOException,
                           AutomationException

Indicates whether the map has a time-enabled layer.

Returns:

The hasTimeData

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultTimeInterval

double getDefaultTimeInterval()
                              throws java.io.IOException,
                                     AutomationException

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

Returns:

The interval

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultTimeInterval

void setDefaultTimeInterval(double interval)
                            throws java.io.IOException,
                                   AutomationException

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

Parameters:

interval - The interval (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultTimeIntervalUnits

int getDefaultTimeIntervalUnits()
                                throws java.io.IOException,
                                       AutomationException

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

Returns:

A com.esri.arcgis.system.esriTimeUnits constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultTimeIntervalUnits

void setDefaultTimeIntervalUnits(int units)
                                 throws java.io.IOException,
                                        AutomationException

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

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultTimeWindow

double getDefaultTimeWindow()
                            throws java.io.IOException,
                                   AutomationException

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

Returns:

The duration

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultTimeWindow

void setDefaultTimeWindow(double duration)
                          throws java.io.IOException,
                                 AutomationException

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

Parameters:

duration - The duration (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullTimeExtent

ITimeExtent getFullTimeExtent()
                              throws java.io.IOException,
                                     AutomationException

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFullTimeExtentByRef

void setFullTimeExtentByRef(ITimeExtent timeExtent)
                            throws java.io.IOException,
                                   AutomationException

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

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentTimeExtent

ITimeExtent getCurrentTimeExtent()
                                 throws java.io.IOException,
                                        AutomationException

The current time extent of the map.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentTimeExtentByRef

void setCurrentTimeExtentByRef(ITimeExtent timeExtent)
                               throws java.io.IOException,
                                      AutomationException

The current time extent of the map.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeValue

ITimeValue getTimeValue()
                        throws java.io.IOException,
                               AutomationException

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeValueByRef

void setTimeValueByRef(ITimeValue time)
                       throws java.io.IOException,
                              AutomationException

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

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeReference

ITimeReference getTimeReference()
                                throws java.io.IOException,
                                       AutomationException

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeReferenceByRef

void setTimeReferenceByRef(ITimeReference timeReference)
                           throws java.io.IOException,
                                  AutomationException

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

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayDateFormat

java.lang.String getDisplayDateFormat()
                                      throws java.io.IOException,
                                             AutomationException

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

Returns:

The dateFormat

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayDateFormat

void setDisplayDateFormat(java.lang.String dateFormat)
                          throws java.io.IOException,
                                 AutomationException

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

Parameters:

dateFormat - The dateFormat (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayTimeFormat

java.lang.String getDisplayTimeFormat()
                                      throws java.io.IOException,
                                             AutomationException

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

Returns:

The timeFormat

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayTimeFormat

void setDisplayTimeFormat(java.lang.String timeFormat)
                          throws java.io.IOException,
                                 AutomationException

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

Parameters:

timeFormat - The timeFormat (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDisplayEachTimestamp

boolean isDisplayEachTimestamp()
                               throws java.io.IOException,
                                      AutomationException

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

Returns:

The value

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayEachTimestamp

void setDisplayEachTimestamp(boolean value)
                             throws java.io.IOException,
                                    AutomationException

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

Parameters:

value - The value (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplaySpeed

int getDisplaySpeed()
                    throws java.io.IOException,
                           AutomationException

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

Returns:

The speed

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplaySpeed

void setDisplaySpeed(int speed)
                     throws java.io.IOException,
                            AutomationException

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

Parameters:

speed - The speed (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPlayOption

int getPlayOption()
                  throws java.io.IOException,
                         AutomationException

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

Returns:

A com.esri.arcgis.carto.esriMapTimePlayOption constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPlayOption

void setPlayOption(int option)
                   throws java.io.IOException,
                          AutomationException

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

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeExtentOption

int getTimeExtentOption()
                        throws java.io.IOException,
                               AutomationException

Indicates how the time extent of the map is defined.

Returns:

A com.esri.arcgis.carto.esriMapTimeExtentOption constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeExtentOption

void setTimeExtentOption(int option)
                         throws java.io.IOException,
                                AutomationException

Indicates how the time extent of the map is defined.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeExtentDefinitionLayer

ILayer getTimeExtentDefinitionLayer()
                                    throws java.io.IOException,
                                           AutomationException

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeExtentDefinitionLayerByRef

void setTimeExtentDefinitionLayerByRef(ILayer layer)
                                       throws java.io.IOException,
                                              AutomationException

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

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDynamicTimeRefresh

boolean isDynamicTimeRefresh()
                             throws java.io.IOException,
                                    AutomationException

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

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDynamicTimeRefresh

void setDynamicTimeRefresh(boolean flag)
                           throws java.io.IOException,
                                  AutomationException

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

Parameters:

flag - The flag (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowTime

boolean isShowTime()
                   throws java.io.IOException,
                          AutomationException

Indicates whether time is enabled on the map.

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowTime

void setShowTime(boolean flag)
                 throws java.io.IOException,
                        AutomationException

Indicates whether time is enabled on the map.

Parameters:

flag - The flag (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

computeFullTimeExtent

ITimeExtent computeFullTimeExtent()
                                  throws java.io.IOException,
                                         AutomationException

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.