com.esri.arcgis.trackinganalyst
Interface ITemporalLegendClass

All Superinterfaces:
Serializable
All Known Implementing Classes:
TemporalLegendClass

public interface ITemporalLegendClass
extends Serializable

Provides access to properties to manage temporal ranges.

Description

The TemporalRenderRange interface provides the required methods and properties to manipulate temporal ranges for the temporal render object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.


Method Summary
 String getDescription()
          Legend class description.
 ILegendClassFormat getFormat()
          Optional.
 String getLabel()
          Legend class label.
 double getPeriod()
          Indicates period setting for temporal data layer.
 double getStartingOffset()
          Indicates initial offset setting for temporal data.
 ISymbol getSymbol()
          Legend class symbol.
 IColor getSymbolColor()
          Indicates symbol size setting for temporal events as they display on the map.
 double getSymbolSize()
          Indicates symbol size setting for temporal events as they display on the map.
 int getTimeUnits()
          Indicates unit of time used to define period of time window.
 int getType()
          Identifies special drawing properties of a temporal legend class.
 boolean intersects(Object vTimeValue)
          Determines whether or not the Time Value intersects the Reference and TimeValue parameters.
 void setDescription(String label)
          Legend class description.
 void setFormat(ILegendClassFormat format)
          Optional.
 void setLabel(String label)
          Legend class label.
 void setPeriod(double pVal)
          Indicates period setting for temporal data layer.
 void setReference(Object varReference)
          Sets the temporal reference properties for the temporal legend class.
 void setStartingOffset(double pVal)
          Indicates initial offset setting for temporal data.
 void setSymbolByRef(ISymbol symbol)
          Legend class symbol.
 void setTimeUnits(int pVal)
          Indicates unit of time used to define period of time window.
 void setType(int penumTemporalLegendType)
          Identifies special drawing properties of a temporal legend class.
 

Method Detail

getSymbol

ISymbol getSymbol()
                  throws IOException,
                         AutomationException
Legend class symbol.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:
A reference to a com.esri.arcgis.display.ISymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSymbolByRef

void setSymbolByRef(ISymbol symbol)
                    throws IOException,
                           AutomationException
Legend class symbol.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
symbol - A reference to a com.esri.arcgis.display.ISymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabel

String getLabel()
                throws IOException,
                       AutomationException
Legend class label.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:
The label
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabel

void setLabel(String label)
              throws IOException,
                     AutomationException
Legend class label.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
label - The label (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription

String getDescription()
                      throws IOException,
                             AutomationException
Legend class description.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:
The label
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDescription

void setDescription(String label)
                    throws IOException,
                           AutomationException
Legend class description.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
label - The label (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFormat

ILegendClassFormat getFormat()
                             throws IOException,
                                    AutomationException
Optional. If non-null, then layer specifies class formatting information.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:
A reference to a com.esri.arcgis.carto.ILegendClassFormat
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFormat

void setFormat(ILegendClassFormat format)
               throws IOException,
                      AutomationException
Optional. If non-null, then layer specifies class formatting information.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
format - A reference to a com.esri.arcgis.carto.ILegendClassFormat (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStartingOffset

double getStartingOffset()
                         throws IOException,
                                AutomationException
Indicates initial offset setting for temporal data.

Description

The starting offset property is used to determine the period of time from the current temporal perspective that the range is to be evaluated for.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStartingOffset

void setStartingOffset(double pVal)
                       throws IOException,
                              AutomationException
Indicates initial offset setting for temporal data.

Description

The starting offset property is used to determine the period of time from the current temporal perspective that the range is to be evaluated for.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPeriod

double getPeriod()
                 throws IOException,
                        AutomationException
Indicates period setting for temporal data layer.

Description

The period property is the amount of history or period of time from the Starting offset that the period is to be evaluated for.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPeriod

void setPeriod(double pVal)
               throws IOException,
                      AutomationException
Indicates period setting for temporal data layer.

Description

The period property is the amount of history or period of time from the Starting offset that the period is to be evaluated for.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTimeUnits

int getTimeUnits()
                 throws IOException,
                        AutomationException
Indicates unit of time used to define period of time window.

Description

The time units property defines the time units that the Starting Offset and period property values use.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:
A com.esri.arcgis.trackinganalyst.enumTemporalUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTimeUnits

void setTimeUnits(int pVal)
                  throws IOException,
                         AutomationException
Indicates unit of time used to define period of time window.

Description

The time units property defines the time units that the Starting Offset and period property values use.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
pVal - A com.esri.arcgis.trackinganalyst.enumTemporalUnits constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getType

int getType()
            throws IOException,
                   AutomationException
Identifies special drawing properties of a temporal legend class.

Description

The Type is used to identify special drawing properties of a temporal legend class. The valid values are as follows:

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:
A com.esri.arcgis.trackinganalyst.enumTemporalLegendType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setType

void setType(int penumTemporalLegendType)
             throws IOException,
                    AutomationException
Identifies special drawing properties of a temporal legend class.

Description

The Type is used to identify special drawing properties of a temporal legend class. The valid values are as follows:

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
penumTemporalLegendType - A com.esri.arcgis.trackinganalyst.enumTemporalLegendType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

intersects

boolean intersects(Object vTimeValue)
                   throws IOException,
                          AutomationException
Determines whether or not the Time Value intersects the Reference and TimeValue parameters.

Description

The intersects method takes two parameters--
* Reference
* TimeValue
and determines whether or not the Time Value intersects this range.

The Reference and TimeValue arguments use the CTimeStamp Variant format which is a array of 3 long integers. See the CTimeStamp documentation for further details.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
vTimeValue - A Variant (in)
Returns:
The pbInersects
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReference

void setReference(Object varReference)
                  throws IOException,
                         AutomationException
Sets the temporal reference properties for the temporal legend class.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
varReference - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSymbolSize

double getSymbolSize()
                     throws IOException,
                            AutomationException
Indicates symbol size setting for temporal events as they display on the map.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:
The pdSize
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSymbolColor

IColor getSymbolColor()
                      throws IOException,
                             AutomationException
Indicates symbol size setting for temporal events as they display on the map.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.