com.esri.arcgis.trackinganalyst
Interface ITrackingLayerLabels

All Superinterfaces:
Serializable
All Known Implementing Classes:
TemporalFeatureLayer

public interface ITrackingLayerLabels
extends Serializable

Provides access to properties and methods needed to manage the tracking layer labels in the map display.

Product Availability

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


Method Summary
 String getLabelFieldName()
          Name of the field whose contents will be used as the tracking label for the layer.
 double getOffsetAngle()
          Indicates angle of offset for labels as they draw next to events on the map display.
 short getPixelOffset()
          Indicates amount of offset between feature and label as they draw to the map display.
 ITextSymbol getTextSymbol()
          Indicates settings for text symbol appearance as it appears as a label on the map display.
 boolean isLabelFeatures()
          Indicates whether or not feature labels will appear as events draw to the map display.
 void setLabelFeatures(boolean pbvarLabelFeatures)
          Indicates whether or not feature labels will appear as events draw to the map display.
 void setLabelFieldName(String pbstrFieldName)
          Name of the field whose contents will be used as the tracking label for the layer.
 void setOffsetAngle(double pdOffsetAngle)
          Indicates angle of offset for labels as they draw next to events on the map display.
 void setPixelOffset(short pnPixelOffset)
          Indicates amount of offset between feature and label as they draw to the map display.
 void setTextSymbolByRef(ITextSymbol ppiTextSymbol)
          Indicates settings for text symbol appearance as it appears as a label on the map display.
 

Method Detail

setLabelFieldName

void setLabelFieldName(String pbstrFieldName)
                       throws IOException,
                              AutomationException
Name of the field whose contents will be used as the tracking label for the layer.

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 for the layer.

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 feature labels will appear as events draw to the map display.

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 feature labels will appear as events draw to the map display.

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 between feature and label as they draw to the map display.

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 between feature and label as they draw to 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.

getOffsetAngle

double getOffsetAngle()
                      throws IOException,
                             AutomationException
Indicates angle of offset for labels as they draw next to events on the map display.

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 as they draw next to events 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 text symbol appearance as it appears as a label on the map display.

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 text symbol appearance as it appears as a label on the map display.

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.