com.esri.arcgis.trackinganalyst
Interface ITrackingLayerLabels

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
ITrackingLayerLabelsProxy, TemporalFeatureLayer

public interface ITrackingLayerLabels
extends java.io.Serializable

COM Interface 'ITrackingLayerLabels'. Generated 3/19/2015 1:21:00 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description: 'Provides access to properties and methods needed to manage the tracking layer labels in the map display.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID10f256e0_f0c9_11d5_b81b_00010265adc5
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 java.lang.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(java.lang.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.
 

Field Detail

IID10f256e0_f0c9_11d5_b81b_00010265adc5

static final int IID10f256e0_f0c9_11d5_b81b_00010265adc5
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

setLabelFieldName

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

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

getLabelFieldName

java.lang.String getLabelFieldName()
                                   throws java.io.IOException,
                                          AutomationException
Name of the field whose contents will be used as the tracking label for the layer.

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

setLabelFeatures

void setLabelFeatures(boolean pbvarLabelFeatures)
                      throws java.io.IOException,
                             AutomationException
Indicates whether or not feature labels will appear as events draw to the map display.

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

isLabelFeatures

boolean isLabelFeatures()
                        throws java.io.IOException,
                               AutomationException
Indicates whether or not feature labels will appear as events draw to the map display.

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

getPixelOffset

short getPixelOffset()
                     throws java.io.IOException,
                            AutomationException
Indicates amount of offset between feature and label as they draw to the map display.

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

setPixelOffset

void setPixelOffset(short pnPixelOffset)
                    throws java.io.IOException,
                           AutomationException
Indicates amount of offset between feature and label as they draw to the map display.

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

getOffsetAngle

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

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

setOffsetAngle

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

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

getTextSymbol

ITextSymbol getTextSymbol()
                          throws java.io.IOException,
                                 AutomationException
Indicates settings for text symbol appearance as it appears as a label on the map display.

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

setTextSymbolByRef

void setTextSymbolByRef(ITextSymbol ppiTextSymbol)
                        throws java.io.IOException,
                               AutomationException
Indicates settings for text symbol appearance as it appears as a label on the map display.

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