com.esri.arcgis.trackinganalyst
Interface ITemporalLegendGroup

All Superinterfaces:
Serializable
All Known Implementing Classes:
TemporalLegendGroup

public interface ITemporalLegendGroup
extends Serializable

Provides access to properties and methods needed to manage the temporal legend group of classes.

Description

The Temporal Legend contains rules on how to render symbology with temporal characteristics.

Product Availability

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


Method Summary
 void addClass(ILegendClass legendClass)
          Adds a new legend class to the group at the end of list.
 void clearClasses()
          Removes all classes from the group.
 ILegendClass esri_getClass(int index)
          Legend class at the specified index.
 int getClassCount()
          Number of legend classes in the group.
 String getColorRampName()
          ESRI pre-defined color ramp last used by the temporal renderer property page to update this object; this value is used to create default temporal legend class symbology colors.
 String getDescription()
          Text description of the temporal legend group.
 String getHeading()
          String heading.
 ITemporalLegendClass getTemporalLegendClass(int nRangeNdx)
          Temporal Legend Class at specified index from this group.
 void insertClass(int index, ILegendClass legendClass)
          Inserts a new legend class into the group at the specified index.
 int intersects(Object pvTimeValue, ISymbol[] ppiSymbol, IColor[] ppiSymbolColor, double[] pdSymbolSize)
          Determines whether a given timestamp value is contained within one of the group's temporal classes.
 boolean isEditable()
          Indicates if the group can be edited.
 boolean isSuppress()
          Controls whether or not to use the temporal legend classes during intersect or time period computation for a temporal query.
 boolean isVisible()
          Indicates if the group is displayed.
 void moveClass(int nCurrentIndex, int nDestinationIndex)
          Moves a temporal legend class from its current position to a new destination within the temporal legend group's legend class container.
 void removeClass(int index)
          Removes the legend class from the group at the specified index.
 void setColorRampName(String pbstrColorRampName)
          ESRI pre-defined color ramp last used by the temporal renderer property page to update this object; this value is used to create default temporal legend class symbology colors.
 void setDescription(String pbstrDescription)
          Text description of the temporal legend group.
 void setEditable(boolean editable)
          Indicates if the group can be edited.
 void setHeading(String heading)
          String heading.
 void setReference(Object varReference)
          Sets temporal reference information for the temporal legend group.
 void setSuppress(boolean pbSuppress)
          Controls whether or not to use the temporal legend classes during intersect or time period computation for a temporal query.
 void setVisible(boolean visible)
          Indicates if the group is displayed.
 void update()
          Updates the temporal legend with new values.
 void verify(boolean[] bNoProblems)
          Checks ranges within a group to determine if group is ordered properly and has correct offsets.
 

Method Detail

isVisible

boolean isVisible()
                  throws IOException,
                         AutomationException
Indicates if the group is displayed.

Product Availability

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

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

setVisible

void setVisible(boolean visible)
                throws IOException,
                       AutomationException
Indicates if the group is displayed.

Product Availability

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

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

isEditable

boolean isEditable()
                   throws IOException,
                          AutomationException
Indicates if the group can be edited. Default is editable.

Product Availability

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

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

setEditable

void setEditable(boolean editable)
                 throws IOException,
                        AutomationException
Indicates if the group can be edited. Default is editable.

Product Availability

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

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

getHeading

String getHeading()
                  throws IOException,
                         AutomationException
String heading.

Product Availability

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

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

setHeading

void setHeading(String heading)
                throws IOException,
                       AutomationException
String heading.

Product Availability

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

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

getClassCount

int getClassCount()
                  throws IOException,
                         AutomationException
Number of legend classes in the group.

Product Availability

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

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

esri_getClass

ILegendClass esri_getClass(int index)
                           throws IOException,
                                  AutomationException
Legend class at the specified index.

Product Availability

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

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

addClass

void addClass(ILegendClass legendClass)
              throws IOException,
                     AutomationException
Adds a new legend class to the group at the end of list.

Product Availability

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

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

insertClass

void insertClass(int index,
                 ILegendClass legendClass)
                 throws IOException,
                        AutomationException
Inserts a new legend class into the group at the specified index.

Product Availability

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

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

removeClass

void removeClass(int index)
                 throws IOException,
                        AutomationException
Removes the legend class from the group at the specified index.

Product Availability

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

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

clearClasses

void clearClasses()
                  throws IOException,
                         AutomationException
Removes all classes from the group.

Product Availability

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

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

getColorRampName

String getColorRampName()
                        throws IOException,
                               AutomationException
ESRI pre-defined color ramp last used by the temporal renderer property page to update this object; this value is used to create default temporal legend class symbology colors.

Description

The Color Ramp Name property is the name of an ESRI pre-defined color ramp that was last used by the TemporalRenderer property page that updated this object. This value is used to create default temporal legend class symbology colors. This property is the name of an ESRI color ramp obtained from ESRI's pre-defined color ramps. The Temporal Renderer's property page uses this property to obtain the color ramp in order to build default temporal legend classes and symbology for the legend classes' symbols.

Product Availability

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

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

setColorRampName

void setColorRampName(String pbstrColorRampName)
                      throws IOException,
                             AutomationException
ESRI pre-defined color ramp last used by the temporal renderer property page to update this object; this value is used to create default temporal legend class symbology colors.

Description

The Color Ramp Name property is the name of an ESRI pre-defined color ramp that was last used by the TemporalRenderer property page that updated this object. This value is used to create default temporal legend class symbology colors. This property is the name of an ESRI color ramp obtained from ESRI's pre-defined color ramps. The Temporal Renderer's property page uses this property to obtain the color ramp in order to build default temporal legend classes and symbology for the legend classes' symbols.

Product Availability

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

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

getDescription

String getDescription()
                      throws IOException,
                             AutomationException
Text description of the temporal legend group.

Description

The Description property contains a description of this Temporal Group. This is the same property as Heading from ILegendGroup.

Product Availability

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

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

setDescription

void setDescription(String pbstrDescription)
                    throws IOException,
                           AutomationException
Text description of the temporal legend group.

Description

The Description property contains a description of this Temporal Group. This is the same property as Heading from ILegendGroup.

Product Availability

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

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

getTemporalLegendClass

ITemporalLegendClass getTemporalLegendClass(int nRangeNdx)
                                            throws IOException,
                                                   AutomationException
Temporal Legend Class at specified index from this group.

Product Availability

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

Parameters:
nRangeNdx - The nRangeNdx (in)
Returns:
A reference to a com.esri.arcgis.trackinganalyst.ITemporalLegendClass
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSuppress

boolean isSuppress()
                   throws IOException,
                          AutomationException
Controls whether or not to use the temporal legend classes during intersect or time period computation for a temporal query.

Description

The Suppress property controls whether or not to use the temporal legend classes during intersect or computation of the time period needed for a temporal query.

Product Availability

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

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

setSuppress

void setSuppress(boolean pbSuppress)
                 throws IOException,
                        AutomationException
Controls whether or not to use the temporal legend classes during intersect or time period computation for a temporal query.

Description

The Suppress property controls whether or not to use the temporal legend classes during intersect or computation of the time period needed for a temporal query.

Product Availability

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

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

setReference

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

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.

intersects

int intersects(Object pvTimeValue,
               ISymbol[] ppiSymbol,
               IColor[] ppiSymbolColor,
               double[] pdSymbolSize)
               throws IOException,
                      AutomationException
Determines whether a given timestamp value is contained within one of the group's temporal classes.

Description

This method determines if a given absolute time, timestamp, is contained within one of this class's temporal legend classes. If so it returns the index of
the legend class that should be used, and it returns the associated symbol for that temporal legend class.

Product Availability

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

Parameters:
pvTimeValue - A Variant (in)
ppiSymbol - A reference to a com.esri.arcgis.display.ISymbol (in/out: use single element array)
ppiSymbolColor - A reference to a com.esri.arcgis.display.IColor (in/out: use single element array)
pdSymbolSize - The pdSymbolSize (in/out: use single element array)
Returns:
The pnUseSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

update

void update()
            throws IOException,
                   AutomationException
Updates the temporal legend with new values.

Description

The Update method updates the legend. Each temporal range in this legend calls this method to have the temporal legend update the ranges in order to maintain a sorted range list from future to past/normal and compute the correct offsets.

Product Availability

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

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

moveClass

void moveClass(int nCurrentIndex,
               int nDestinationIndex)
               throws IOException,
                      AutomationException
Moves a temporal legend class from its current position to a new destination within the temporal legend group's legend class container.

Description

The move Class method moves a Temporal Legend Class from the current position to the destination position within the Temporal Legend Groups Legend Class container.

Product Availability

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

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

verify

void verify(boolean[] bNoProblems)
            throws IOException,
                   AutomationException
Checks ranges within a group to determine if group is ordered properly and has correct offsets.

Description

The verify method checks the ranges within a group to determine if the group is ordered properly and has correct offsets. It does not fix any detected problems; it only returns a boolean result.

Product Availability

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

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