com.esri.arcgis.trackinganalyst
Interface ITrackingTextLabel

All Superinterfaces:
Serializable
All Known Implementing Classes:
TrackingLabel

public interface ITrackingTextLabel
extends Serializable

Provides access to properties and methods for controlling tracking text labels.

Product Availability

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


Method Summary
 void draw(IDisplay piDisplay)
          Draws the label to the map display.
 IEnvelope getEnvelope()
          Provide the envelope of the label (currently, does nothing).
 String getID()
          Label Identifier.
 String getLabelText()
          Defines label text.
 IGeometry getLocation()
          Labels Geometric Location.
 double getOffsetAngle()
          Indicates pixel offset bearing from centroid of location.
 short getPixelOffset()
          Indicates pixel offset from centroid of location.
 ITextSymbol getTextSymbol()
          Defines symbol(s) used in text label.
 boolean isDirty()
          Indicates if the label properties have changed since last drawn.
 boolean isVisible()
          Indicates whether or not the text label is visible when drawing events on the map.
 void setID(String pbstrID)
          Label Identifier.
 void setLabelText(String pbstrLabelText)
          Defines label text.
 void setLocationByRef(IGeometry ppiLocation)
          Labels Geometric Location.
 void setOffsetAngle(double pdOffsetAngle)
          Indicates pixel offset bearing from centroid of location.
 void setPixelOffset(short pnPixelOffset)
          Indicates pixel offset from centroid of location.
 void setTextSymbolByRef(ITextSymbol ppiTextSymbol)
          Defines symbol(s) used in text label.
 void setVisible(boolean pbvarVisible)
          Indicates whether or not the text label is visible when drawing events on the map.
 

Method Detail

isDirty

boolean isDirty()
                throws IOException,
                       AutomationException
Indicates if the label properties have changed since last drawn.

Product Availability

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

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

getID

String getID()
             throws IOException,
                    AutomationException
Label Identifier.

Description

This property indicates ID value for the label.

Product Availability

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

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

setID

void setID(String pbstrID)
           throws IOException,
                  AutomationException
Label Identifier.

Product Availability

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

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

getEnvelope

IEnvelope getEnvelope()
                      throws IOException,
                             AutomationException
Provide the envelope of the label (currently, does nothing).

Description

This property indicates the envelope of the label.

Product Availability

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

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

setLocationByRef

void setLocationByRef(IGeometry ppiLocation)
                      throws IOException,
                             AutomationException
Labels Geometric Location.

Product Availability

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

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

getLocation

IGeometry getLocation()
                      throws IOException,
                             AutomationException
Labels Geometric Location.

Description

This property indicates the labelís geometric location.

Product Availability

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

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

draw

void draw(IDisplay piDisplay)
          throws IOException,
                 AutomationException
Draws the label to the map display.

Product Availability

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

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

isVisible

boolean isVisible()
                  throws IOException,
                         AutomationException
Indicates whether or not the text label is visible when drawing events on the map.

Product Availability

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

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

setVisible

void setVisible(boolean pbvarVisible)
                throws IOException,
                       AutomationException
Indicates whether or not the text label is visible when drawing events on the map.

Product Availability

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

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

getPixelOffset

short getPixelOffset()
                     throws IOException,
                            AutomationException
Indicates pixel offset from centroid of location.

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 pixel offset from centroid of location.

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 pixel offset bearing from centroid of location.

Description

This property indicates 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.

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 pixel offset bearing from centroid of location.

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.

getLabelText

String getLabelText()
                    throws IOException,
                           AutomationException
Defines label text.

Product Availability

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

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

setLabelText

void setLabelText(String pbstrLabelText)
                  throws IOException,
                         AutomationException
Defines label text.

Product Availability

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

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

getTextSymbol

ITextSymbol getTextSymbol()
                          throws IOException,
                                 AutomationException
Defines symbol(s) used in text label.

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
Defines symbol(s) used in text label.

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.