com.esri.arcgis.animation
Interface ITimeWindow

All Superinterfaces:

Serializable

All Known Implementing Classes:

TimeWindow

public interface ITimeWindow
extends Serializable

Provides access to the properties/methods of the time window.

Remarks

A time window defines the temporal dimension of the time layer. This interface provides access to the properties of the time window.

Product Availability

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

Method Summary

String	getDefinitionQuery() The definition query.
String	getEndField() The end field.
String	getEndFieldFormat() The end field format.
String	getStartField() The start field.
String	getStartFieldFormat() The start field format.
boolean	isAnimateCumulatively() Indicates whether to animate the display cumulatively.
void	setAnimateCumulatively(boolean pAnimateFieldsCumulatively) Indicates whether to animate the display cumulatively.
void	setDefinitionQuery(String pQuery) The definition query.
void	setEndField(String pField) The end field.
void	setEndFieldFormat(String pFieldFormat) The end field format.
void	setStartField(String pField) The start field.
void	setStartFieldFormat(String pField) The start field format.

Method Detail

getStartField

String getStartField()
                     throws IOException,
                            AutomationException

The start field.

Product Availability

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

Returns:

The pField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartField

void setStartField(String pField)
                   throws IOException,
                          AutomationException

The start field.

Product Availability

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

Parameters:

pField - The pField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndField

String getEndField()
                   throws IOException,
                          AutomationException

The end field.

Product Availability

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

Returns:

The pField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndField

void setEndField(String pField)
                 throws IOException,
                        AutomationException

The end field.

Product Availability

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

Parameters:

pField - The pField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartFieldFormat

String getStartFieldFormat()
                           throws IOException,
                                  AutomationException

The start field format.

Product Availability

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

Returns:

The pField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartFieldFormat

void setStartFieldFormat(String pField)
                         throws IOException,
                                AutomationException

The start field format.

Product Availability

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

Parameters:

pField - The pField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndFieldFormat

String getEndFieldFormat()
                         throws IOException,
                                AutomationException

The end field format.

Product Availability

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

Returns:

The pFieldFormat

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndFieldFormat

void setEndFieldFormat(String pFieldFormat)
                       throws IOException,
                              AutomationException

The end field format.

Product Availability

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

Parameters:

pFieldFormat - The pFieldFormat (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAnimateCumulatively

boolean isAnimateCumulatively()
                              throws IOException,
                                     AutomationException

Indicates whether to animate the display cumulatively.

Product Availability

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

Returns:

The pAnimateFieldsCumulatively

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAnimateCumulatively

void setAnimateCumulatively(boolean pAnimateFieldsCumulatively)
                            throws IOException,
                                   AutomationException

Indicates whether to animate the display cumulatively.

Product Availability

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

Parameters:

pAnimateFieldsCumulatively - The pAnimateFieldsCumulatively (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefinitionQuery

String getDefinitionQuery()
                          throws IOException,
                                 AutomationException

The definition query.

Remarks

This property stores the pre-existing definition query of a time layer before time animation is played.

Product Availability

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

Returns:

The pQuery

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefinitionQuery

void setDefinitionQuery(String pQuery)
                        throws IOException,
                               AutomationException

The definition query.

Product Availability

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

Parameters:

pQuery - The pQuery (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.