com.esri.arcgis.trackinganalyst
Interface ISimpleTrackingLabelRenderer

All Superinterfaces:

Serializable

All Known Implementing Classes:

CoTrackSymbologyRenderer

public interface ISimpleTrackingLabelRenderer
extends Serializable

Provides access to properties and methods needed to manage the renderer for simple tracking labels.

Product Availability

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

Method Summary

IUID	getID() Indicates ID value of event for tracking label renderer.
String	getLabelFieldName() Name of the field whose contents will be used as the tracking label when drawing to the map display.
double	getOffsetAngle() Indicates angle of offset for labels to display from the event on the map display.
short	getPixelOffset() Indicates amount of offset for the label renderer to draw labels next to events in the map display.
ITextSymbol	getTextSymbol() Indicates settings for the text symbol appearance used to label temporal events.
boolean	isDisplayOnlyLastKnownFeatures() Indicates whether only the last known or all features will be drawn to the map display.
boolean	isLabelFeatures() Indicates whether or not labeling for features is turned on.
void	setDisplayOnlyLastKnownFeatures(boolean pbvarDisplayOnlyLastKnownFeatures) Indicates whether only the last known or all features will be drawn to the map display.
void	setLabelFeatures(boolean pbvarLabelFeatures) Indicates whether or not labeling for features is turned on.
void	setLabelFieldName(String pbstrFieldName) Name of the field whose contents will be used as the tracking label when drawing to the map display.
void	setLastKnownFIDsByRef(IFeatureIDSet rhs1) Indicates whether or not last known feature IDs will be drawn to the map display.
void	setOffsetAngle(double pdOffsetAngle) Indicates angle of offset for labels to display from the event on the map display.
void	setPixelOffset(short pnPixelOffset) Indicates amount of offset for the label renderer to draw labels next to events in the map display.
void	setTextSymbolByRef(ITextSymbol ppiTextSymbol) Indicates settings for the text symbol appearance used to label temporal events.

Method Detail

setDisplayOnlyLastKnownFeatures

void setDisplayOnlyLastKnownFeatures(boolean pbvarDisplayOnlyLastKnownFeatures)
                                     throws IOException,
                                            AutomationException

Indicates whether only the last known or all features will be drawn to the map display.

Product Availability

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

Parameters:

pbvarDisplayOnlyLastKnownFeatures - The pbvarDisplayOnlyLastKnownFeatures (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDisplayOnlyLastKnownFeatures

boolean isDisplayOnlyLastKnownFeatures()
                                       throws IOException,
                                              AutomationException

Indicates whether only the last known or all features will be drawn to the map display.

Product Availability

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

Returns:

The pbvarDisplayOnlyLastKnownFeatures

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLastKnownFIDsByRef

void setLastKnownFIDsByRef(IFeatureIDSet rhs1)
                           throws IOException,
                                  AutomationException

Indicates whether or not last known feature IDs will be drawn to the map display.

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.

setLabelFieldName

void setLabelFieldName(String pbstrFieldName)
                       throws IOException,
                              AutomationException

Name of the field whose contents will be used as the tracking label when drawing to the map display.

Product Availability

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

Parameters:

pbstrFieldName - The pbstrFieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelFieldName

String getLabelFieldName()
                         throws IOException,
                                AutomationException

Name of the field whose contents will be used as the tracking label when drawing to the map display.

Remarks

CoTemporalFeatureLayer’s ITrackingLayerLabels controls/sets the property under this interface in Tracking Analyst.

Product Availability

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

Returns:

The pbstrFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelFeatures

void setLabelFeatures(boolean pbvarLabelFeatures)
                      throws IOException,
                             AutomationException

Indicates whether or not labeling for features is turned on.

Product Availability

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

Parameters:

pbvarLabelFeatures - The pbvarLabelFeatures (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLabelFeatures

boolean isLabelFeatures()
                        throws IOException,
                               AutomationException

Indicates whether or not labeling for features is turned on.

Remarks

CoTemporalFeatureLayer’s ITrackingLayerLabels controls/sets the property under this interface in Tracking Analyst.

Product Availability

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

Returns:

The pbvarLabelFeatures

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPixelOffset

short getPixelOffset()
                     throws IOException,
                            AutomationException

Indicates amount of offset for the label renderer to draw labels next to events in the map display.

Remarks

CoTemporalFeatureLayer’s ITrackingLayerLabels controls/sets the property under this interface in Tracking Analyst.

Product Availability

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

Returns:

The pnPixelOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPixelOffset

void setPixelOffset(short pnPixelOffset)
                    throws IOException,
                           AutomationException

Indicates amount of offset for the label renderer to draw labels next to events in the map display.

Product Availability

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

Parameters:

pnPixelOffset - The pnPixelOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getID

IUID getID()
           throws IOException,
                  AutomationException

Indicates ID value of event for tracking label renderer.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOffsetAngle

double getOffsetAngle()
                      throws IOException,
                             AutomationException

Indicates angle of offset for labels to display from the event on the map display.

Remarks

CoTemporalFeatureLayer’s ITrackingLayerLabels controls/sets the property under this interface in Tracking Analyst.

Product Availability

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

Returns:

The pdOffsetAngle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOffsetAngle

void setOffsetAngle(double pdOffsetAngle)
                    throws IOException,
                           AutomationException

Indicates angle of offset for labels to display from the event on the map display.

Product Availability

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

Parameters:

pdOffsetAngle - The pdOffsetAngle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextSymbol

ITextSymbol getTextSymbol()
                          throws IOException,
                                 AutomationException

Indicates settings for the text symbol appearance used to label temporal events.

Remarks

CoTemporalFeatureLayer’s ITrackingLayerLabels controls/sets the property under this interface in Tracking Analyst.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.display.ITextSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextSymbolByRef

void setTextSymbolByRef(ITextSymbol ppiTextSymbol)
                        throws IOException,
                               AutomationException

Indicates settings for the text symbol appearance used to label temporal events.

Product Availability

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

Parameters:

ppiTextSymbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.