com.esri.arcgis.trackinganalyst
Interface ITemporalRenderer

All Superinterfaces:
Serializable
All Known Implementing Classes:
CoTrackSymbologyRenderer

public interface ITemporalRenderer
extends Serializable

Provides access to methods and properties needed to apply symbology with temporal color as well as standard ESRI symbology.

Description

The TemporalRenderer interface provides methods and properties needed to get symbology that has temporal color as well as other standard esri symbology.

Product Availability

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


Method Summary
 boolean canRender(IFeatureClass featClass, IDisplay display)
          Indicates if the specified feature class can be rendered on the given display.
 void canRenderComponent(IFeatureClass piFeatClass, IDisplay piDisplay, boolean[] pbvarResult, Object piComponent, String bstrComponent)
          Uses the renderer from component tree in symbology dialog to determine if this renderer can be used with this component.
 void draw(IFeatureCursor cursor, int drawPhase, IDisplay display, ITrackCancel trackCancel)
          Draws features from the specified cursor on the given display.
 IPropertySet getComponentSets()
          Used to contain the properties of all of the various temporal renderers.
 IFeatureRenderer getObservationRenderer()
          Renders observation symbology using functionality of standard ESRI symbology system.
 ISymbol getSymbolByFeature(IFeature feature)
          Symbol used to draw the specified feature.
 String getTemporalFieldName()
          Identifies the temporal field, which must be a field type whoe data can be converted to a date value.
 ITemporalLegendGroup getTemporalLegend()
          Points to a Temporal Legend class that defines how symbology is rendered temporally.
 String getTemporalObjectColumnName()
          Indicates the feature class column that identifies or groups temporal observations with time series.
 Object getTemporalPerspective()
          A timestamp that the temporal renderer uses to compare its time ranges stored in the temporal legend's temporal classes.
 int getTimeSymbologyMethod()
          Controls how temporal characteristics are symbolized: by none, color, transparency, shape, or size.
 boolean isDisplayFutureEvents()
          Indicates whether or not future events are drawn on the map in real-time mode.
 boolean isRenderPhase(int drawPhase)
          Indicates if renderer uses the specified draw phase.
 boolean isShowObservationLegendGroup()
          Controls whether or not the observation legend is drawn in the table of contents.
 boolean isShowTimeLegendGroup()
          Controls access to the time legend group.
 void prepareFilter(IFeatureClass fc, IQueryFilter queryFilter)
          Prepares the query filter for the rendering process.
 void setComponentSets(IPropertySet pVal)
          Used to contain the properties of all of the various temporal renderers.
 void setDisplayFutureEvents(boolean pVal)
          Indicates whether or not future events are drawn on the map in real-time mode.
 void setExclusionSetByRef(IFeatureIDSet rhs1)
          An object reference to a temporary drawing exclusion set.
 void setFromPropertyPages(boolean rhs1)
          Indicates who is making the request for the legend: the property pages.
 void setMostCurrentFIDs(IFeatureIDSet piFIDSet)
          Method SetMostCurrentFIDs.
 void setObservationRendererByRef(IFeatureRenderer ppiRenderer)
          Renders observation symbology using functionality of standard ESRI symbology system.
 void setShowObservationLegendGroup(boolean pbShowObservations)
          Controls whether or not the observation legend is drawn in the table of contents.
 void setShowTimeLegendGroup(boolean pbShowTimeLegends)
          Controls access to the time legend group.
 void setTemporalFieldName(String pbstrTemporalFieldName)
          Identifies the temporal field, which must be a field type whoe data can be converted to a date value.
 void setTemporalLegendByRef(ITemporalLegendGroup ppiTemporalLegend)
          Points to a Temporal Legend class that defines how symbology is rendered temporally.
 void setTemporalObjectColumnName(String pVal)
          Indicates the feature class column that identifies or groups temporal observations with time series.
 void setTemporalPerspective(Object pVal)
          A timestamp that the temporal renderer uses to compare its time ranges stored in the temporal legend's temporal classes.
 void setTimeSymbologyMethod(int penumSymbolizationMethod)
          Controls how temporal characteristics are symbolized: by none, color, transparency, shape, or size.
 

Method Detail

canRender

boolean canRender(IFeatureClass featClass,
                  IDisplay display)
                  throws IOException,
                         AutomationException
Indicates if the specified feature class can be rendered on the given display.

Product Availability

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

Parameters:
featClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
display - A reference to a com.esri.arcgis.display.IDisplay (in)
Returns:
The result
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

prepareFilter

void prepareFilter(IFeatureClass fc,
                   IQueryFilter queryFilter)
                   throws IOException,
                          AutomationException
Prepares the query filter for the rendering process.

Product Availability

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

Parameters:
fc - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

draw

void draw(IFeatureCursor cursor,
          int drawPhase,
          IDisplay display,
          ITrackCancel trackCancel)
          throws IOException,
                 AutomationException
Draws features from the specified cursor on the given display.

Product Availability

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

Parameters:
cursor - A reference to a com.esri.arcgis.geodatabase.IFeatureCursor (in)
drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)
display - A reference to a com.esri.arcgis.display.IDisplay (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSymbolByFeature

ISymbol getSymbolByFeature(IFeature feature)
                           throws IOException,
                                  AutomationException
Symbol used to draw the specified feature.

Product Availability

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

Parameters:
feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)
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.

isRenderPhase

boolean isRenderPhase(int drawPhase)
                      throws IOException,
                             AutomationException
Indicates if renderer uses the specified draw phase.

Product Availability

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

Parameters:
drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)
Returns:
The result
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExclusionSetByRef

void setExclusionSetByRef(IFeatureIDSet rhs1)
                          throws IOException,
                                 AutomationException
An object reference to a temporary drawing exclusion set.

Product Availability

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

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

getObservationRenderer

IFeatureRenderer getObservationRenderer()
                                        throws IOException,
                                               AutomationException
Renders observation symbology using functionality of standard ESRI symbology system.

Description

The FeatureRenderer is the standard Renderer used for rendering Observation symbology. This renderer is used as a slave in order to take advantage of the functionality of the standard ESRI symbology system.

Product Availability

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

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

setObservationRendererByRef

void setObservationRendererByRef(IFeatureRenderer ppiRenderer)
                                 throws IOException,
                                        AutomationException
Renders observation symbology using functionality of standard ESRI symbology system.

Description

The FeatureRenderer is the standard Renderer used for rendering Observation symbology. This renderer is used as a slave in order to take advantage of the functionality of the standard ESRI symbology system.

Product Availability

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

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

getTemporalFieldName

String getTemporalFieldName()
                            throws IOException,
                                   AutomationException
Identifies the temporal field, which must be a field type whoe data can be converted to a date value.

Description

The Temporal Fieldname property identifies the temporal field. This field must be a field type with data that can be converted to a date value.

Product Availability

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

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

setTemporalFieldName

void setTemporalFieldName(String pbstrTemporalFieldName)
                          throws IOException,
                                 AutomationException
Identifies the temporal field, which must be a field type whoe data can be converted to a date value.

Description

The Temporal Fieldname property identifies the temporal field. This field must be a field type with data that can be converted to a date value.

Product Availability

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

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

isShowObservationLegendGroup

boolean isShowObservationLegendGroup()
                                     throws IOException,
                                            AutomationException
Controls whether or not the observation legend is drawn in the table of contents.

Description

This property controls whether or not the Observation legend is drawn in the table of contents view.

Product Availability

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

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

setShowObservationLegendGroup

void setShowObservationLegendGroup(boolean pbShowObservations)
                                   throws IOException,
                                          AutomationException
Controls whether or not the observation legend is drawn in the table of contents.

Description

This property controls whether or not the Observation legend is drawn in the table of contents view.

Product Availability

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

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

isShowTimeLegendGroup

boolean isShowTimeLegendGroup()
                              throws IOException,
                                     AutomationException
Controls access to the time legend group.

Description

This property controls the access to the time legend group.

Product Availability

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

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

setShowTimeLegendGroup

void setShowTimeLegendGroup(boolean pbShowTimeLegends)
                            throws IOException,
                                   AutomationException
Controls access to the time legend group.

Description

This property controls the access to the time legend group.

Product Availability

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

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

getTemporalLegend

ITemporalLegendGroup getTemporalLegend()
                                       throws IOException,
                                              AutomationException
Points to a Temporal Legend class that defines how symbology is rendered temporally.

Description

This property points to a Temporal Legend class that defines how symbology is rendered temporally.

Product Availability

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

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

setTemporalLegendByRef

void setTemporalLegendByRef(ITemporalLegendGroup ppiTemporalLegend)
                            throws IOException,
                                   AutomationException
Points to a Temporal Legend class that defines how symbology is rendered temporally.

Description

This property points to a Temporal Legend class that defines how symbology is rendered temporally.

Product Availability

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

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

setFromPropertyPages

void setFromPropertyPages(boolean rhs1)
                          throws IOException,
                                 AutomationException
Indicates who is making the request for the legend: the property pages.

Description

This Property will tell the get_TemporalLegend who's making the request for the legend: the PropertyPages not someone else.

Product Availability

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

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

getTimeSymbologyMethod

int getTimeSymbologyMethod()
                           throws IOException,
                                  AutomationException
Controls how temporal characteristics are symbolized: by none, color, transparency, shape, or size.

Description

This property controls how temporal characteristics are to be symbolized.This property has 5 potential values:

1) None
2) Color
3) Transparency
4) Shape
5) Size

None disables any modifications to the observers feature renderer symbology. This effectively disables temporal symbology and the temporal renderer only limits the data to be displayed.

Color modifies the color of the symbology obtained from the observers feature renderer with that of the temporal range that the feature intersects with.

Transparency modifies the transparency of the symbology obtained from the observers feature renderer with that of the temporal range that the feature intersects with.

Shape and Size are only applicable to point feature classes.

Shape set the marker symbol and then obtains the color and size information from the observers feature renderer. This symbol is then rendered to the screen.

Size modifies the size of the marker symbol obtained from the observers feature renderer with that of the temporal range that the feature intersects with.

Product Availability

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

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

setTimeSymbologyMethod

void setTimeSymbologyMethod(int penumSymbolizationMethod)
                            throws IOException,
                                   AutomationException
Controls how temporal characteristics are symbolized: by none, color, transparency, shape, or size.

Description

This property controls how temporal characteristics are to be symbolized.This property has 5 potential values:

1) None
2) Color
3) Transparency
4) Shape
5) Size

None disables any modifications to the observers feature renderer symbology. This effectively disables temporal symbology and the temporal renderer only limits the data to be displayed.

Color modifies the color of the symbology obtained from the observers feature renderer with that of the temporal range that the feature intersects with.

Transparency modifies the transparency of the symbology obtained from the observers feature renderer with that of the temporal range that the feature intersects with.

Shape and Size are only applicable to point feature classes.

Shape set the marker symbol and then obtains the color and size information from the observers feature renderer. This symbol is then rendered to the screen.

Size modifies the size of the marker symbol obtained from the observers feature renderer with that of the temporal range that the feature intersects with.

Product Availability

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

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

getTemporalObjectColumnName

String getTemporalObjectColumnName()
                                   throws IOException,
                                          AutomationException
Indicates the feature class column that identifies or groups temporal observations with time series.

Description

This property identifies the feature classes column that identifies or groups temporal observations with time series. This is usually refered to as the event column name.

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.

setTemporalObjectColumnName

void setTemporalObjectColumnName(String pVal)
                                 throws IOException,
                                        AutomationException
Indicates the feature class column that identifies or groups temporal observations with time series.

Description

This property identifies the feature classes column that identifies or groups temporal observations with time series. This is usually refered to as the event column name.

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.

getTemporalPerspective

Object getTemporalPerspective()
                              throws IOException,
                                     AutomationException
A timestamp that the temporal renderer uses to compare its time ranges stored in the temporal legend's temporal classes.

Description

The Temporal Perspective is the point in time that the temporal renderer uses to compare its time ranges stored in the temporal legends temporal classes. These ranges define the correct symbology to apply to the observation renderers symbology for the time difference from the features time to the temporal perspective. This value is returned as an internal format and can be set using a string, date, or internal format. This internal format can be converted using a temporalreference object.

Product Availability

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

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

setTemporalPerspective

void setTemporalPerspective(Object pVal)
                            throws IOException,
                                   AutomationException
A timestamp that the temporal renderer uses to compare its time ranges stored in the temporal legend's temporal classes.

Description

The Temporal Perspective is the point in time that the temporal renderer uses to compare its time ranges stored in the temporal legends temporal classes. These ranges define the correct symbology to apply to the observation renderers symbology for the time difference from the features time to the temporal perspective. This value is returned as an internal format and can be set using a string, date, or internal format. This internal format can be converted using a temporalreference object.

Product Availability

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

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

getComponentSets

IPropertySet getComponentSets()
                              throws IOException,
                                     AutomationException
Used to contain the properties of all of the various temporal renderers.

Description

This property is used to hold the properties that control how the various Child Renderers behave. These properties are presented in a hiearchy of parent children. The top level contains a label identifier, and the top level renderers that the implementation of this interfaces exposes. Each level or child is implemented as a property set object with the following minimum properties.

Minimum Properties:

Property

Type

Description

Label

Read

CanLabel

Read

CanDisable

Read

Enabled

Read/Write

Enables this feature or renderer.

CategoryID

Read/Write

Category ID to

Object

Read/Write

Child object or child renderer

DefaultSymbol

Read/Write

PageID

Read/Write

Class ID of the property page used to edit this function


Product Availability

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

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

setComponentSets

void setComponentSets(IPropertySet pVal)
                      throws IOException,
                             AutomationException
Used to contain the properties of all of the various temporal renderers.

Description

This property is used to hold the properties that control how the various Child Renderers behave. These properties are presented in a hiearchy of parent children. The top level contains a label identifier, and the top level renderers that the implementation of this interfaces exposes. Each level or child is implemented as a property set object with the following minimum properties.

Minimum Properties:

Property

Type

Description

Label

Read

CanLabel

Read

CanDisable

Read

Enabled

Read/Write

Enables this feature or renderer.

CategoryID

Read/Write

Category ID to

Object

Read/Write

Child object or child renderer

DefaultSymbol

Read/Write

PageID

Read/Write

Class ID of the property page used to edit this function


Product Availability

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

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

canRenderComponent

void canRenderComponent(IFeatureClass piFeatClass,
                        IDisplay piDisplay,
                        boolean[] pbvarResult,
                        Object piComponent,
                        String bstrComponent)
                        throws IOException,
                               AutomationException
Uses the renderer from component tree in symbology dialog to determine if this renderer can be used with this component.

Description

This method is an override of the ILegendInfo->CanRender. It uses the component (Renderer from component Tree in symbology dialog) to determine if this renderer can be used with this component.

Product Availability

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

Parameters:
piFeatClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
piDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)
pbvarResult - The pbvarResult (in/out: use single element array)
piComponent - A reference to another Object (IUnknown) (in)
bstrComponent - The bstrComponent (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMostCurrentFIDs

void setMostCurrentFIDs(IFeatureIDSet piFIDSet)
                        throws IOException,
                               AutomationException
Method SetMostCurrentFIDs.

Product Availability

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

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

isDisplayFutureEvents

boolean isDisplayFutureEvents()
                              throws IOException,
                                     AutomationException
Indicates whether or not future events are drawn on the map in real-time mode.

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.

setDisplayFutureEvents

void setDisplayFutureEvents(boolean pVal)
                            throws IOException,
                                   AutomationException
Indicates whether or not future events are drawn on the map in real-time mode.

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.