edu.ucdavis.cstars.client.layers

Class LayerTimeOptions

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.layers.LayerTimeOptions

public class LayerTimeOptions
extends com.google.gwt.core.client.JavaScriptObject

Defines the time options for the layer.

Author:

Justin Merz

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getTimeDataCumulative() If true, the layer will draw all features from the beginning of the data's time extent.
int	getTimeOffset() The length of time the data is offset from the time when the data was recorded.
TimeInfo.TimeUnits	getTimeOffsetUnits() Temporal unit in which the time offset is measured.
void	setTimeDataCumulative(boolean timeDataCumulative) Set the timeDataCumulative parameter.
void	setTimeOffset(int timeOffset) Set the timeOffset parameter.
void	setTimeOffsetUnit(TimeInfo.TimeUnits timeOffsetUnits) Set the timeOffsetUnits parameter.
void	setUseTime(boolean useTime) Set the useTime parameter.
boolean	useTime() If true, the layer participates in time-related rendering and query operations.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getTimeDataCumulative

public final boolean getTimeDataCumulative()

If true, the layer will draw all features from the beginning of the data's time extent.

Returns:

boolean

setTimeDataCumulative

public final void setTimeDataCumulative(boolean timeDataCumulative)

Set the timeDataCumulative parameter.

Parameters:

timeDataCumulative - -If true, the layer will draw all features from the beginning of the data's time extent.

getTimeOffset

public final int getTimeOffset()

The length of time the data is offset from the time when the data was recorded. Specify the units using the timeOffsetUnits property.

Returns:

int

setTimeOffset

public final void setTimeOffset(int timeOffset)

Set the timeOffset parameter.

Parameters:

timeOffset - - The length of time the data is offset from the time when the data was recorded. Specify the units using the timeOffsetUnits property.

getTimeOffsetUnits

public final TimeInfo.TimeUnits getTimeOffsetUnits()

Temporal unit in which the time offset is measured.

Returns:

TimeUnits

setTimeOffsetUnit

public final void setTimeOffsetUnit(TimeInfo.TimeUnits timeOffsetUnits)

Set the timeOffsetUnits parameter.

Parameters:

timeOffsetUnits - - Temporal unit in which the time offset is measured.

useTime

public final boolean useTime()

If true, the layer participates in time-related rendering and query operations.

Returns:

boolean

setUseTime

public final void setUseTime(boolean useTime)

Set the useTime parameter.

Parameters:

useTime - - If true, the layer participates in time-related rendering and query operations.