|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ITimeDataDisplay
Provides access to time animation related properties of a layer.
ITimeDataDisplay is an interface which provides details about how the layer can treat the time-related data when it responds to temporal queries. The properties in this interface do not need to be changed in order for the layer to display time-related data. They are used to make the display of time-related data more meaningful, and to make analysis of the data more effective in certain settings.
Method Summary | |
---|---|
double |
getTimeInterval()
Returns recommended time interval to be used to animate this layer/ table. |
int |
getTimeIntervalUnits()
Returns recommended time interval units to be used to animate this layer/ table. |
double |
getTimeOffset()
Returns time offset that needs to be applied to the data for drawing. |
int |
getTimeOffsetUnits()
Returns recommended time interval units to be used to animate this layer/ table. |
boolean |
isTimeDataCumulative()
Indicates that features will be animated cumilatively. |
void |
setTimeDataCumulative(boolean cumilative)
Indicates that features will be animated cumilatively. |
void |
setTimeInterval(double interval)
Returns recommended time interval to be used to animate this layer/ table. |
void |
setTimeIntervalUnits(int units)
Returns recommended time interval units to be used to animate this layer/ table. |
void |
setTimeOffset(double timeOffset)
Returns time offset that needs to be applied to the data for drawing. |
void |
setTimeOffsetUnits(int units)
Returns recommended time interval units to be used to animate this layer/ table. |
Method Detail |
---|
void setTimeDataCumulative(boolean cumilative) throws IOException, AutomationException
cumilative
- The cumilative (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isTimeDataCumulative() throws IOException, AutomationException
TimeDataCumulative is true when the data should be persist on the display as it ages. This is useful in settings where the new data "builds upon" historical data. For example when displaying the location of a wild animal, this property will cause the layer to display all of the historical locations for the animal, providing a good view of the animal's territory.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setTimeInterval(double interval) throws IOException, AutomationException
interval
- The interval (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.double getTimeInterval() throws IOException, AutomationException
This property represents the time interval of the data used when rendering the layer. The time interval represents the minimum expected time between changes in the data. For example, when using weather imagery that is updated every 10 minutes, you would set the time interval to 10 minutes. When using census data that is recorded every year, the time interval would be set to 1 year. Note that this property is the value of the interval, and must be set along with the units for the time interval.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setTimeIntervalUnits(int units) throws IOException, AutomationException
units
- A com.esri.arcgis.system.esriTimeUnits constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getTimeIntervalUnits() throws IOException, AutomationException
This property is the enumerated value representing the time units used when measuring the time interval. This property should be read/written along with the time interval value. For more information about the time interval, see the documentation on the TimeInterval property.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setTimeOffset(double timeOffset) throws IOException, AutomationException
timeOffset
- The timeOffset (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.double getTimeOffset() throws IOException, AutomationException
The TimeOffset is used to display data at a different time on the timeline. This is for temporary purposes only. It can be useful for comparing data sets from different time period when you need to display the two sets of data together. For example, to visualize the growth pattern of two wild fires that happened in two different years, one of the layers can be given an offset that will cause it to appear as if the fire started at the same time as the other fire. In this way the growth patterns can be seen together, and compared.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setTimeOffsetUnits(int units) throws IOException, AutomationException
units
- A com.esri.arcgis.system.esriTimeUnits constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getTimeOffsetUnits() throws IOException, AutomationException
This property is the enumerated value representing the time units used when measuring the time offset. This property should be read/written along with the time offset value. For more information about the time offset, see the documentation on the TimeOffset property.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |