com.esri.arcgis.trackinganalyst
Interface ITrackingGlobeLayerLeaderLines

All Superinterfaces:
Serializable
All Known Implementing Classes:
TemporalFeatureLayer

public interface ITrackingGlobeLayerLeaderLines
extends Serializable

Provides access to properties and methods needed to manage tracking globe layer leader lines.

Product Availability

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


Method Summary
 IColor getElevatedLinesColor()
          Specifies the color of the elevated lines.
 double getElevatedLinesLength()
          Indicates the length of the elevated lines.
 int getElevatedLinesLengthUnits()
          Indicates the units for the length of the elevated line.
 IColor getElevatedLinesPointColor()
          Specifies the color of the point located at the base of the elevated lines.
 double getElevatedLinesPointWidth()
          Indicates the width of the point located at the base of the elevated lines.
 int getElevatedLinesStyle()
          Indicates the style of the elevated lines, and whether or not to elevate the symbols so they don't sink into the globe.
 double getElevatedLinesWidth()
          Indicates the width of the elevated lines in pixels.
 IColor getLeaderLinesColor()
          Specifies the color of the leader line.
 double getLeaderLinesWidth()
          Indicates the width of the leader lines in pixels.
 boolean isDrawLeaderLines()
          Indicates whether to draw leader lines from the symbol to the surface.
 boolean isElevatedLinesPointUseSymbolColor()
          Indicates whether the color of the point located at the base of the elevated lines will be colored according to the elevated lines point color property or according to the symbolized feature it points to.
 boolean isElevatedLinesUseSymbolColor()
          Indicates whether the elevated line will be colored according to the elevated lines color property or according to the symbolized feature it points to.
 boolean isLeaderLinesUseSymbolColor()
          Indicates whether the leader line will be colored according to the leader lines color property or according to the symbolized feature it points to.
 boolean isSmoothElevatedLinesPoint()
          Indicates whether to smooth the point located at the base of the elevated lines.
 void setDrawLeaderLines(boolean draw)
          Indicates whether to draw leader lines from the symbol to the surface.
 void setElevatedLinesColor(IColor color)
          Specifies the color of the elevated lines.
 void setElevatedLinesLength(double length)
          Indicates the length of the elevated lines.
 void setElevatedLinesLengthUnits(int lengthUnits)
          Indicates the units for the length of the elevated line.
 void setElevatedLinesPointColor(IColor color)
          Specifies the color of the point located at the base of the elevated lines.
 void setElevatedLinesPointUseSymbolColor(boolean useSymbolColor)
          Indicates whether the color of the point located at the base of the elevated lines will be colored according to the elevated lines point color property or according to the symbolized feature it points to.
 void setElevatedLinesPointWidth(double width)
          Indicates the width of the point located at the base of the elevated lines.
 void setElevatedLinesStyle(int style)
          Indicates the style of the elevated lines, and whether or not to elevate the symbols so they don't sink into the globe.
 void setElevatedLinesUseSymbolColor(boolean useSymbolColor)
          Indicates whether the elevated line will be colored according to the elevated lines color property or according to the symbolized feature it points to.
 void setElevatedLinesWidth(double width)
          Indicates the width of the elevated lines in pixels.
 void setLeaderLinesColor(IColor color)
          Specifies the color of the leader line.
 void setLeaderLinesUseSymbolColor(boolean useSymbolColor)
          Indicates whether the leader line will be colored according to the leader lines color property or according to the symbolized feature it points to.
 void setLeaderLinesWidth(double width)
          Indicates the width of the leader lines in pixels.
 void setSmoothElevatedLinesPoint(boolean smooth)
          Indicates whether to smooth the point located at the base of the elevated lines.
 

Method Detail

isDrawLeaderLines

boolean isDrawLeaderLines()
                          throws IOException,
                                 AutomationException
Indicates whether to draw leader lines from the symbol to the surface.

Product Availability

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

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

setDrawLeaderLines

void setDrawLeaderLines(boolean draw)
                        throws IOException,
                               AutomationException
Indicates whether to draw leader lines from the symbol to the surface.

Product Availability

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

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

isLeaderLinesUseSymbolColor

boolean isLeaderLinesUseSymbolColor()
                                    throws IOException,
                                           AutomationException
Indicates whether the leader line will be colored according to the leader lines color property or according to the symbolized feature it points to.

Product Availability

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

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

setLeaderLinesUseSymbolColor

void setLeaderLinesUseSymbolColor(boolean useSymbolColor)
                                  throws IOException,
                                         AutomationException
Indicates whether the leader line will be colored according to the leader lines color property or according to the symbolized feature it points to.

Product Availability

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

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

getLeaderLinesColor

IColor getLeaderLinesColor()
                           throws IOException,
                                  AutomationException
Specifies the color of the leader line.

Product Availability

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

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

setLeaderLinesColor

void setLeaderLinesColor(IColor color)
                         throws IOException,
                                AutomationException
Specifies the color of the leader line.

Product Availability

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

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

getElevatedLinesStyle

int getElevatedLinesStyle()
                          throws IOException,
                                 AutomationException
Indicates the style of the elevated lines, and whether or not to elevate the symbols so they don't sink into the globe.

Product Availability

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

Returns:
A com.esri.arcgis.trackinganalyst.esriTrackingElevatedLineStyle constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setElevatedLinesStyle

void setElevatedLinesStyle(int style)
                           throws IOException,
                                  AutomationException
Indicates the style of the elevated lines, and whether or not to elevate the symbols so they don't sink into the globe.

Product Availability

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

Parameters:
style - A com.esri.arcgis.trackinganalyst.esriTrackingElevatedLineStyle constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isElevatedLinesUseSymbolColor

boolean isElevatedLinesUseSymbolColor()
                                      throws IOException,
                                             AutomationException
Indicates whether the elevated line will be colored according to the elevated lines color property or according to the symbolized feature it points to.

Product Availability

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

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

setElevatedLinesUseSymbolColor

void setElevatedLinesUseSymbolColor(boolean useSymbolColor)
                                    throws IOException,
                                           AutomationException
Indicates whether the elevated line will be colored according to the elevated lines color property or according to the symbolized feature it points to.

Product Availability

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

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

isElevatedLinesPointUseSymbolColor

boolean isElevatedLinesPointUseSymbolColor()
                                           throws IOException,
                                                  AutomationException
Indicates whether the color of the point located at the base of the elevated lines will be colored according to the elevated lines point color property or according to the symbolized feature it points to.

Product Availability

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

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

setElevatedLinesPointUseSymbolColor

void setElevatedLinesPointUseSymbolColor(boolean useSymbolColor)
                                         throws IOException,
                                                AutomationException
Indicates whether the color of the point located at the base of the elevated lines will be colored according to the elevated lines point color property or according to the symbolized feature it points to.

Product Availability

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

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

getElevatedLinesColor

IColor getElevatedLinesColor()
                             throws IOException,
                                    AutomationException
Specifies the color of the elevated lines.

Product Availability

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

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

setElevatedLinesColor

void setElevatedLinesColor(IColor color)
                           throws IOException,
                                  AutomationException
Specifies the color of the elevated lines.

Product Availability

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

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

getElevatedLinesLength

double getElevatedLinesLength()
                              throws IOException,
                                     AutomationException
Indicates the length of the elevated lines.

Product Availability

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

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

setElevatedLinesLength

void setElevatedLinesLength(double length)
                            throws IOException,
                                   AutomationException
Indicates the length of the elevated lines.

Product Availability

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

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

getElevatedLinesLengthUnits

int getElevatedLinesLengthUnits()
                                throws IOException,
                                       AutomationException
Indicates the units for the length of the elevated line.

Product Availability

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

Returns:
A com.esri.arcgis.system.esriUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setElevatedLinesLengthUnits

void setElevatedLinesLengthUnits(int lengthUnits)
                                 throws IOException,
                                        AutomationException
Indicates the units for the length of the elevated line.

Product Availability

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

Parameters:
lengthUnits - A com.esri.arcgis.system.esriUnits constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElevatedLinesWidth

double getElevatedLinesWidth()
                             throws IOException,
                                    AutomationException
Indicates the width of the elevated lines in pixels.

Product Availability

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

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

setElevatedLinesWidth

void setElevatedLinesWidth(double width)
                           throws IOException,
                                  AutomationException
Indicates the width of the elevated lines in pixels.

Product Availability

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

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

getLeaderLinesWidth

double getLeaderLinesWidth()
                           throws IOException,
                                  AutomationException
Indicates the width of the leader lines in pixels.

Product Availability

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

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

setLeaderLinesWidth

void setLeaderLinesWidth(double width)
                         throws IOException,
                                AutomationException
Indicates the width of the leader lines in pixels.

Product Availability

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

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

getElevatedLinesPointWidth

double getElevatedLinesPointWidth()
                                  throws IOException,
                                         AutomationException
Indicates the width of the point located at the base of the elevated lines.

Product Availability

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

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

setElevatedLinesPointWidth

void setElevatedLinesPointWidth(double width)
                                throws IOException,
                                       AutomationException
Indicates the width of the point located at the base of the elevated lines.

Product Availability

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

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

isSmoothElevatedLinesPoint

boolean isSmoothElevatedLinesPoint()
                                   throws IOException,
                                          AutomationException
Indicates whether to smooth the point located at the base of the elevated lines.

Product Availability

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

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

setSmoothElevatedLinesPoint

void setSmoothElevatedLinesPoint(boolean smooth)
                                 throws IOException,
                                        AutomationException
Indicates whether to smooth the point located at the base of the elevated lines.

Product Availability

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

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

getElevatedLinesPointColor

IColor getElevatedLinesPointColor()
                                  throws IOException,
                                         AutomationException
Specifies the color of the point located at the base of the elevated lines.

Remarks

When the elevated lines point color property is set to NULL (0), the point color will follow the elevated lines color property.

Product Availability

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

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

setElevatedLinesPointColor

void setElevatedLinesPointColor(IColor color)
                                throws IOException,
                                       AutomationException
Specifies the color of the point located at the base of the elevated lines.

Remarks

When the elevated lines point color property is set to NULL (0), the point color will follow the elevated lines color property.

Product Availability

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

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