com.esri.arcgis.trackinganalyst
Interface ITrackSymbologyRenderer

All Superinterfaces:
Serializable
All Known Implementing Classes:
CoTrackSymbologyRenderer

public interface ITrackSymbologyRenderer
extends Serializable

Provides access to methods and properties needed to manage the temporal symbology rendering of events.

Description

The Track Symbology Renderer 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 draw(IFeatureCursor cursor, int drawPhase, IDisplay display, ITrackCancel trackCancel)
          Draws features from the specified cursor on the given display.
 ISymbol getSymbolByFeature(IFeature feature)
          Symbol used to draw the specified feature.
 IFeatureRenderer getTrackSymbologyRenderer()
          Controls the temporal track symbology drawn on the map.
 boolean isRenderPhase(int drawPhase)
          Indicates if renderer uses the specified draw phase.
 boolean isShowTrackSymbologyLegendGroup()
          Indicates whether or not track symbology displays when drawing temporal events on the map.
 void prepareFilter(IFeatureClass fc, IQueryFilter queryFilter)
          Prepares the query filter for the rendering process.
 void setExclusionSetByRef(IFeatureIDSet rhs1)
          An object reference to a temporary drawing exclusion set.
 void setShowTrackSymbologyLegendGroup(boolean pbShowTimeLegends)
          Indicates whether or not track symbology displays when drawing temporal events on the map.
 void setTrackSymbologyRendererByRef(IFeatureRenderer ppiRenderer)
          Controls the temporal track symbology drawn on the map.
 

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.

isShowTrackSymbologyLegendGroup

boolean isShowTrackSymbologyLegendGroup()
                                        throws IOException,
                                               AutomationException
Indicates whether or not track symbology displays when drawing temporal events on the map.

Description

This property controls the access to the track symbology 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.

setShowTrackSymbologyLegendGroup

void setShowTrackSymbologyLegendGroup(boolean pbShowTimeLegends)
                                      throws IOException,
                                             AutomationException
Indicates whether or not track symbology displays when drawing temporal events on the map.

Description

This property controls the access to the track symbology 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.

getTrackSymbologyRenderer

IFeatureRenderer getTrackSymbologyRenderer()
                                           throws IOException,
                                                  AutomationException
Controls the temporal track symbology drawn on the map.

Description

This property identifies the feature renderer to be used for the track symbology renderer.

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.

setTrackSymbologyRendererByRef

void setTrackSymbologyRendererByRef(IFeatureRenderer ppiRenderer)
                                    throws IOException,
                                           AutomationException
Controls the temporal track symbology drawn on the map.

Description

This property identifies the feature renderer to be used for the track symbology renderer.

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.