com.esri.arcgis.trackinganalyst
Interface ITrackingLabelEngine

All Superinterfaces:

Serializable

All Known Subinterfaces:

ITrackingLabelEngine2

All Known Implementing Classes:

LabelEngine

public interface ITrackingLabelEngine
extends Serializable

Provides access to properties and methods for controlling the tracking label engine used for dynamically changing labels.

Superseded By

ITrackingLabelEngine2

Remarks

Note: the ITrackingLabelEngine interface has been superseded by ITrackingLabelEngine2. Please consider using the more recent version.

Product Availability

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

Method Summary

void	addLabel(String bstrID, ILayer piLayer, ITrackingLabel piLabel) Adds a tracking label to the map display.
void	attach(IMap piMap) Attaches a label to a given feature on the map.
void	draw(IDisplay piDisplay) Draws the labels to the map display.
ITrackingLabel	findLabel(String bstrID, ILayer piLayer) Finds a given label for the map display.
void	hideLabels(ILayer piLayer, IGeometry piGeometry) Hides labels from the map display.
void	removeAllLabels() Removes all labels from the map display.
void	removeLabel(String bstrID, ILayer piLayer) Removes a tracking label from the map display.
void	removeLayerLabels(ILayer piLayer) Remove labels from a given layer.

Method Detail

addLabel

void addLabel(String bstrID,
              ILayer piLayer,
              ITrackingLabel piLabel)
              throws IOException,
                     AutomationException

Adds a tracking label to the map display.

Product Availability

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

Parameters:

bstrID - The bstrID (in)

piLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

piLabel - A reference to a com.esri.arcgis.trackinganalyst.ITrackingLabel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findLabel

ITrackingLabel findLabel(String bstrID,
                         ILayer piLayer)
                         throws IOException,
                                AutomationException

Finds a given label for the map display.

Description

This method finds a given label specified by the ID for the map display.

Product Availability

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

Parameters:

bstrID - The bstrID (in)

piLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Returns:

A reference to a com.esri.arcgis.trackinganalyst.ITrackingLabel

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 labels 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.

removeLabel

void removeLabel(String bstrID,
                 ILayer piLayer)
                 throws IOException,
                        AutomationException

Removes a tracking label from the map display.

Product Availability

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

Parameters:

bstrID - The bstrID (in)

piLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAllLabels

void removeAllLabels()
                     throws IOException,
                            AutomationException

Removes all labels from the map display.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

attach

void attach(IMap piMap)
            throws IOException,
                   AutomationException

Attaches a label to a given feature on the map.

Product Availability

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

Parameters:

piMap - A reference to a com.esri.arcgis.carto.IMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hideLabels

void hideLabels(ILayer piLayer,
                IGeometry piGeometry)
                throws IOException,
                       AutomationException

Hides labels from the map display.

Product Availability

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

Parameters:

piLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

piGeometry - 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.

removeLayerLabels

void removeLayerLabels(ILayer piLayer)
                       throws IOException,
                              AutomationException

Remove labels from a given layer.

Description

This method removes labels from a given layer.

Product Availability

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

Parameters:

piLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.