com.esri.arcgis.carto
Interface IMapTableTimeDescription

All Superinterfaces:

Serializable

All Known Implementing Classes:

LayerDescription, StandaloneTableDescription

public interface IMapTableTimeDescription
extends Serializable

Provides access to time properties of a LayerDescription.

Remarks

Please note that the following properties only honored in ExportMapImage and Identify operations:

• UseTime
• TimeDataCumulative
• TimeOffset
• TimeOffsetUnits

Product Availability

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

Method Summary

double	getTimeOffset() Draw time offset to overlay the data on a earlier or later time span.
int	getTimeOffsetUnits() Draw time offset units.
boolean	isTimeDataCumulative() Draw the data cumulatively from the first instance of time in data as time progresses.
boolean	isUseTime() Indicates whether use time for display.
void	setTimeDataCumulative(boolean drawCumilative) Draw the data cumulatively from the first instance of time in data as time progresses.
void	setTimeOffset(double offset) Draw time offset to overlay the data on a earlier or later time span.
void	setTimeOffsetUnits(int offsetUnits) Draw time offset units.
void	setUseTime(boolean useTime) Indicates whether use time for display.

Method Detail

isUseTime

boolean isUseTime()
                  throws IOException,
                         AutomationException

Indicates whether use time for display.

Remarks

When UseTime is set to False, the layer or table becomes time unaware and time related operations will ignore any time related settings on this layer or table. For example, when UseTime=False for a layer, ExportMapImage will draw all features from this layer even when IMapTimeDescription's TimeValue is set.

Product Availability

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

Returns:

The useTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseTime

void setUseTime(boolean useTime)
                throws IOException,
                       AutomationException

Indicates whether use time for display.

Product Availability

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

Parameters:

useTime - The useTime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTimeDataCumulative

boolean isTimeDataCumulative()
                             throws IOException,
                                    AutomationException

Draw the data cumulatively from the first instance of time in data as time progresses.

Product Availability

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

Returns:

The drawCumilative

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeDataCumulative

void setTimeDataCumulative(boolean drawCumilative)
                           throws IOException,
                                  AutomationException

Draw the data cumulatively from the first instance of time in data as time progresses.

Product Availability

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

Parameters:

drawCumilative - The drawCumilative (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeOffset

double getTimeOffset()
                     throws IOException,
                            AutomationException

Draw time offset to overlay the data on a earlier or later time span.

Product Availability

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

Returns:

The offset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeOffset

void setTimeOffset(double offset)
                   throws IOException,
                          AutomationException

Draw time offset to overlay the data on a earlier or later time span.

Product Availability

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

Parameters:

offset - The offset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeOffsetUnits

int getTimeOffsetUnits()
                       throws IOException,
                              AutomationException

Draw time offset units.

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.

setTimeOffsetUnits

void setTimeOffsetUnits(int offsetUnits)
                        throws IOException,
                               AutomationException

Draw time offset units.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.