com.esri.arcgis.trackinganalyst
Interface ITrackingLabel

All Superinterfaces:

Serializable

All Known Implementing Classes:

TrackingLabel

public interface ITrackingLabel
extends Serializable

Provides access to properties and methods for controlling tracking 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() Property Envelope.
String	getID() Indicates ID value for the label.
IGeometry	getLocation() Labels geometric location.
double	getOffsetAngle() Indicates the pixel offset bearing from the centroid of the location.
short	getPixelOffset() Indicates the pixel offset from centroid of the location.
boolean	isDirty() Indicates if the label properties have changed since last drawn.
boolean	isVisible() Indicates whether the tracking label is visible on the map display.
void	setID(String pbstrID) Indicates ID value for the label.
void	setLocationByRef(IGeometry ppiLocation) Labels geometric location.
void	setOffsetAngle(double pdOffsetAngle) Indicates the pixel offset bearing from the centroid of the location.
void	setPixelOffset(short pnPixelOffset) Indicates the pixel offset from centroid of the location.
void	setVisible(boolean pbvarVisible) Indicates whether the tracking label is visible on the map display.

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

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

Indicates ID value for the label.

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

Property Envelope.

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 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 the tracking label is visible on the map display.

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 the tracking label is visible on the map display.

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

Description

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

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