com.esri.arcgis.carto
Interface IMaplexOffsetAlongLineProperties

All Superinterfaces:
Serializable
All Known Implementing Classes:
MaplexOffsetAlongLineProperties

public interface IMaplexOffsetAlongLineProperties
extends Serializable

Provides access to members that control the placement of labels along a line feature.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux


Method Summary
 double getDistance()
          Distance along the line.
 int getDistanceUnit()
          The distance and tolerance are interpreted to be in this unit.
 int getLabelAnchorPoint()
          Anchor point on label where distance is measured to.
 int getPlacementMethod()
          Method of placing label along the line.
 double getTolerance()
          Tolerance either side of the specified position.
 boolean isUseLineDirection()
          Indicates whether to preserve the direction of line.
 void setDistance(double distance)
          Distance along the line.
 void setDistanceUnit(int unit)
          The distance and tolerance are interpreted to be in this unit.
 void setLabelAnchorPoint(int option)
          Anchor point on label where distance is measured to.
 void setPlacementMethod(int option)
          Method of placing label along the line.
 void setTolerance(double distance)
          Tolerance either side of the specified position.
 void setUseLineDirection(boolean flag)
          Indicates whether to preserve the direction of line.
 

Method Detail

getPlacementMethod

int getPlacementMethod()
                       throws IOException,
                              AutomationException
Method of placing label along the line.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

setPlacementMethod

void setPlacementMethod(int option)
                        throws IOException,
                               AutomationException
Method of placing label along the line.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

getLabelAnchorPoint

int getLabelAnchorPoint()
                        throws IOException,
                               AutomationException
Anchor point on label where distance is measured to.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

setLabelAnchorPoint

void setLabelAnchorPoint(int option)
                         throws IOException,
                                AutomationException
Anchor point on label where distance is measured to.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

getDistance

double getDistance()
                   throws IOException,
                          AutomationException
Distance along the line.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

setDistance

void setDistance(double distance)
                 throws IOException,
                        AutomationException
Distance along the line.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

getTolerance

double getTolerance()
                    throws IOException,
                           AutomationException
Tolerance either side of the specified position.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

setTolerance

void setTolerance(double distance)
                  throws IOException,
                         AutomationException
Tolerance either side of the specified position.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

getDistanceUnit

int getDistanceUnit()
                    throws IOException,
                           AutomationException
The distance and tolerance are interpreted to be in this unit.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

setDistanceUnit

void setDistanceUnit(int unit)
                     throws IOException,
                            AutomationException
The distance and tolerance are interpreted to be in this unit.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

isUseLineDirection

boolean isUseLineDirection()
                           throws IOException,
                                  AutomationException
Indicates whether to preserve the direction of line.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

setUseLineDirection

void setUseLineDirection(boolean flag)
                         throws IOException,
                                AutomationException
Indicates whether to preserve the direction of line.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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