com.esri.arcgis.carto
Interface IMaplexOverposterLayerProperties

All Superinterfaces:
Serializable
All Known Implementing Classes:
MaplexOverposterLayerProperties

public interface IMaplexOverposterLayerProperties
extends Serializable

Provides access to members that control the placement of labels for a layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 int getConstrainOffset()
          Label constraint options.
 String getDictionaryName()
          Name of the abbreviations dictionary referenced by this layer.
 int getFeatureBuffer()
          Increase buffer around a point feature to stop labels from being placed too close to the feature.
 int getFeatureType()
          The feature type.
 int getFeatureWeight()
          Feature weight controls which features may be overlapped and to what extent.
 double getFontHeightReductionLimit()
          The font may be reduced in height until this limit is reached.
 double getFontHeightReductionStep()
          This is the step interval for font height reduction.
 double getFontWidthReductionLimit()
          The font may be reduced in width until this limit is reached.
 double getFontWidthReductionStep()
          This is the step interval for font width reduction.
 int getLabelBuffer()
          Increase buffer to stop labels from being placed too close to each other.
 int getLabelPriority()
          Label prority controls approximate placement order.
 IMaplexLabelStackingProperties getLabelStackingProperties()
          The label stacking properties for a layer.
 int getLinePlacementMethod()
          Line placement options.
 double getMaximumCharacterSpacing()
          The character spacing may be increased upto this limit.
 double getMaximumLabelOverrun()
          Maximum distance that a label is allowed to overrun the end of its feature.
 double getMaximumWordSpacing()
          The word spacing may be increased upto this limit.
 double getMinimumEndOfStreetClearance()
          Minimum clearance between street label and street end.
 double getMinimumRepetitionInterval()
          Interval that must elapse before label is repeated.
 double getMinimumSizeForLabeling()
          Specifies a minimum size of a line or area feature for it to be labeled.
 IMaplexOffsetAlongLineProperties getOffsetAlongLineProperties()
          The offset along line properties for a layer.
 int getPointPlacementMethod()
          Point placement options.
 IPointPlacementPriorities getPointPlacementPriorities()
          Controls placement of label around point fetaure.
 int getPolygonBoundaryWeight()
          Feature Weight for the boundary of the polygon.
 int getPolygonPlacementMethod()
          Polygon placement options.
 double getPreferredEndOfStreetClearance()
          Preferred clearance between street label and street end.
 double getPrimaryOffset()
          Primary offset between label and symbol.
 int getPrimaryOffsetUnit()
          The primary offset is interpreted to be in this unit.
 IMaplexRotationProperties getRotationProperties()
          The label rotation properties for a layer.
 double getSecondaryOffset()
          Primary offset between label and symbol.
 double getThinningDistance()
          Distance used to control the thinning of duplicate labels.
 boolean isAlignLabelToLineDirection()
          Indicates whether to align the label with the label direction so the label may appear upside down.
 boolean isAllowAsymmetricOverrun()
          Indicates whether a label may overrun one side of a polygon feature.
 boolean isBackgroundLabel()
          Indicates whether to place the label first and allow other labels to be placed over it.
 boolean isCanAbbreviateLabel()
          Indicates whether to abbreviate the label using an abbreviation dictionary.
 boolean isCanOverrunFeature()
          Indicates whether to place the label over end of line or over polygon boundary.
 boolean isCanPlaceLabelOutsidePolygon()
          Indicates whether to place a label outside the polygon if it does not fit inside.
 boolean isCanReduceFontSize()
          Indicates whether to reduce the size of the font.
 boolean isCanRemoveOverlappingLabel()
          Indicates whether to remove the label if it overlaps with other labels.
 boolean isCanShiftPointLabel()
          Indicates whether to allow the point label to be shifted upon a fixed position.
 boolean isCanStackLabel()
          Indicates whether to stack the label to obtain a better position.
 boolean isCanTruncateLabel()
          Indicates whether to truncate the label using an algorithm.
 boolean isEnablePointPlacementPriorities()
          Indicates whether to use user-defined point placement priorities.
 boolean isGraticuleAlignment()
          Indicates whether to enable graticule alignment.
 boolean isLandParcelPlacement()
          Indicates whether to place the label within land parcel polygon avoiding building footprint.
 boolean isNeverRemoveLabel()
          Indicates whether to not remove the label if no position is found.
 boolean isPreferHorizontalPlacement()
          Indicates if there is a preference to place the label horizontally.
 boolean isRepeatLabel()
          Indicates whether to enable the repetition of label along line feature.
 boolean isSpreadCharacters()
          Indicates whether to spread label characters along line feature.
 boolean isSpreadWords()
          Indicates whether to spread words along line feature.
 boolean isStreetPlacement()
          Indicates whether to enable street placement techniques.
 boolean isThinDuplicateLabels()
          Indicates whether to remove duplicate labels that lie within a specified distance of each other.
 void setAlignLabelToLineDirection(boolean flag)
          Indicates whether to align the label with the label direction so the label may appear upside down.
 void setAllowAsymmetricOverrun(boolean flag)
          Indicates whether a label may overrun one side of a polygon feature.
 void setBackgroundLabel(boolean flag)
          Indicates whether to place the label first and allow other labels to be placed over it.
 void setCanAbbreviateLabel(boolean flag)
          Indicates whether to abbreviate the label using an abbreviation dictionary.
 void setCanOverrunFeature(boolean flag)
          Indicates whether to place the label over end of line or over polygon boundary.
 void setCanPlaceLabelOutsidePolygon(boolean flag)
          Indicates whether to place a label outside the polygon if it does not fit inside.
 void setCanReduceFontSize(boolean flag)
          Indicates whether to reduce the size of the font.
 void setCanRemoveOverlappingLabel(boolean flag)
          Indicates whether to remove the label if it overlaps with other labels.
 void setCanShiftPointLabel(boolean flag)
          Indicates whether to allow the point label to be shifted upon a fixed position.
 void setCanStackLabel(boolean flag)
          Indicates whether to stack the label to obtain a better position.
 void setCanTruncateLabel(boolean flag)
          Indicates whether to truncate the label using an algorithm.
 void setConstrainOffset(int option)
          Label constraint options.
 void setDictionaryName(String text)
          Name of the abbreviations dictionary referenced by this layer.
 void setEnablePointPlacementPriorities(boolean flag)
          Indicates whether to use user-defined point placement priorities.
 void setFeatureBuffer(int buffer)
          Increase buffer around a point feature to stop labels from being placed too close to the feature.
 void setFeatureType(int type)
          The feature type.
 void setFeatureWeight(int weight)
          Feature weight controls which features may be overlapped and to what extent.
 void setFontHeightReductionLimit(double limit)
          The font may be reduced in height until this limit is reached.
 void setFontHeightReductionStep(double step)
          This is the step interval for font height reduction.
 void setFontWidthReductionLimit(double limit)
          The font may be reduced in width until this limit is reached.
 void setFontWidthReductionStep(double step)
          This is the step interval for font width reduction.
 void setGraticuleAlignment(boolean flag)
          Indicates whether to enable graticule alignment.
 void setIsStreetPlacement(boolean flag)
          Indicates whether to enable street placement techniques.
 void setLabelBuffer(int buffer)
          Increase buffer to stop labels from being placed too close to each other.
 void setLabelPriority(int priority)
          Label prority controls approximate placement order.
 void setLabelStackingProperties(IMaplexLabelStackingProperties props)
          The label stacking properties for a layer.
 void setLandParcelPlacement(boolean flag)
          Indicates whether to place the label within land parcel polygon avoiding building footprint.
 void setLinePlacementMethod(int method)
          Line placement options.
 void setMaximumCharacterSpacing(double spacing)
          The character spacing may be increased upto this limit.
 void setMaximumLabelOverrun(double distance)
          Maximum distance that a label is allowed to overrun the end of its feature.
 void setMaximumWordSpacing(double spacing)
          The word spacing may be increased upto this limit.
 void setMinimumEndOfStreetClearance(double clearance)
          Minimum clearance between street label and street end.
 void setMinimumRepetitionInterval(double interval)
          Interval that must elapse before label is repeated.
 void setMinimumSizeForLabeling(double size)
          Specifies a minimum size of a line or area feature for it to be labeled.
 void setNeverRemoveLabel(boolean flag)
          Indicates whether to not remove the label if no position is found.
 void setOffsetAlongLineProperties(IMaplexOffsetAlongLineProperties props)
          The offset along line properties for a layer.
 void setPointPlacementMethod(int method)
          Point placement options.
 void setPointPlacementPriorities(IPointPlacementPriorities priorities)
          Controls placement of label around point fetaure.
 void setPolygonBoundaryWeight(int weight)
          Feature Weight for the boundary of the polygon.
 void setPolygonPlacementMethod(int method)
          Polygon placement options.
 void setPreferHorizontalPlacement(boolean flag)
          Indicates if there is a preference to place the label horizontally.
 void setPreferredEndOfStreetClearance(double clearance)
          Preferred clearance between street label and street end.
 void setPrimaryOffset(double offset)
          Primary offset between label and symbol.
 void setPrimaryOffsetUnit(int unit)
          The primary offset is interpreted to be in this unit.
 void setRepeatLabel(boolean flag)
          Indicates whether to enable the repetition of label along line feature.
 void setRotationProperties(IMaplexRotationProperties props)
          The label rotation properties for a layer.
 void setSecondaryOffset(double offset)
          Primary offset between label and symbol.
 void setSpreadCharacters(boolean flag)
          Indicates whether to spread label characters along line feature.
 void setSpreadWords(boolean flag)
          Indicates whether to spread words along line feature.
 void setThinDuplicateLabels(boolean flag)
          Indicates whether to remove duplicate labels that lie within a specified distance of each other.
 void setThinningDistance(double distance)
          Distance used to control the thinning of duplicate labels.
 

Method Detail

getFeatureType

int getFeatureType()
                   throws IOException,
                          AutomationException
The feature type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setFeatureType

void setFeatureType(int type)
                    throws IOException,
                           AutomationException
The feature type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getPointPlacementMethod

int getPointPlacementMethod()
                            throws IOException,
                                   AutomationException
Point placement options.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setPointPlacementMethod

void setPointPlacementMethod(int method)
                             throws IOException,
                                    AutomationException
Point placement options.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getLinePlacementMethod

int getLinePlacementMethod()
                           throws IOException,
                                  AutomationException
Line placement options.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setLinePlacementMethod

void setLinePlacementMethod(int method)
                            throws IOException,
                                   AutomationException
Line placement options.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getPolygonPlacementMethod

int getPolygonPlacementMethod()
                              throws IOException,
                                     AutomationException
Polygon placement options.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setPolygonPlacementMethod

void setPolygonPlacementMethod(int method)
                               throws IOException,
                                      AutomationException
Polygon placement options.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isCanPlaceLabelOutsidePolygon

boolean isCanPlaceLabelOutsidePolygon()
                                      throws IOException,
                                             AutomationException
Indicates whether to place a label outside the polygon if it does not fit inside.

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.

setCanPlaceLabelOutsidePolygon

void setCanPlaceLabelOutsidePolygon(boolean flag)
                                    throws IOException,
                                           AutomationException
Indicates whether to place a label outside the polygon if it does not fit inside.

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.

isPreferHorizontalPlacement

boolean isPreferHorizontalPlacement()
                                    throws IOException,
                                           AutomationException
Indicates if there is a preference to place the label horizontally.

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.

setPreferHorizontalPlacement

void setPreferHorizontalPlacement(boolean flag)
                                  throws IOException,
                                         AutomationException
Indicates if there is a preference to place the label horizontally.

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.

isLandParcelPlacement

boolean isLandParcelPlacement()
                              throws IOException,
                                     AutomationException
Indicates whether to place the label within land parcel polygon avoiding building footprint.

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.

setLandParcelPlacement

void setLandParcelPlacement(boolean flag)
                            throws IOException,
                                   AutomationException
Indicates whether to place the label within land parcel polygon avoiding building footprint.

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.

getPrimaryOffset

double getPrimaryOffset()
                        throws IOException,
                               AutomationException
Primary offset between label and symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setPrimaryOffset

void setPrimaryOffset(double offset)
                      throws IOException,
                             AutomationException
Primary offset between label and symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getPrimaryOffsetUnit

int getPrimaryOffsetUnit()
                         throws IOException,
                                AutomationException
The primary offset is 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.

setPrimaryOffsetUnit

void setPrimaryOffsetUnit(int unit)
                          throws IOException,
                                 AutomationException
The primary offset is 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.

getSecondaryOffset

double getSecondaryOffset()
                          throws IOException,
                                 AutomationException
Primary offset between label and symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setSecondaryOffset

void setSecondaryOffset(double offset)
                        throws IOException,
                               AutomationException
Primary offset between label and symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getConstrainOffset

int getConstrainOffset()
                       throws IOException,
                              AutomationException
Label constraint options.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setConstrainOffset

void setConstrainOffset(int option)
                        throws IOException,
                               AutomationException
Label constraint options.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isEnablePointPlacementPriorities

boolean isEnablePointPlacementPriorities()
                                         throws IOException,
                                                AutomationException
Indicates whether to use user-defined point placement priorities.

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.

setEnablePointPlacementPriorities

void setEnablePointPlacementPriorities(boolean flag)
                                       throws IOException,
                                              AutomationException
Indicates whether to use user-defined point placement priorities.

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.

getPointPlacementPriorities

IPointPlacementPriorities getPointPlacementPriorities()
                                                      throws IOException,
                                                             AutomationException
Controls placement of label around point fetaure.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setPointPlacementPriorities

void setPointPlacementPriorities(IPointPlacementPriorities priorities)
                                 throws IOException,
                                        AutomationException
Controls placement of label around point fetaure.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isCanShiftPointLabel

boolean isCanShiftPointLabel()
                             throws IOException,
                                    AutomationException
Indicates whether to allow the point label to be shifted upon a fixed position.

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.

setCanShiftPointLabel

void setCanShiftPointLabel(boolean flag)
                           throws IOException,
                                  AutomationException
Indicates whether to allow the point label to be shifted upon a fixed position.

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.

isStreetPlacement

boolean isStreetPlacement()
                          throws IOException,
                                 AutomationException
Indicates whether to enable street placement techniques.

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.

setIsStreetPlacement

void setIsStreetPlacement(boolean flag)
                          throws IOException,
                                 AutomationException
Indicates whether to enable street placement techniques.

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.

isRepeatLabel

boolean isRepeatLabel()
                      throws IOException,
                             AutomationException
Indicates whether to enable the repetition of label along line feature.

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.

setRepeatLabel

void setRepeatLabel(boolean flag)
                    throws IOException,
                           AutomationException
Indicates whether to enable the repetition of label along line feature.

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.

getMinimumRepetitionInterval

double getMinimumRepetitionInterval()
                                    throws IOException,
                                           AutomationException
Interval that must elapse before label is repeated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setMinimumRepetitionInterval

void setMinimumRepetitionInterval(double interval)
                                  throws IOException,
                                         AutomationException
Interval that must elapse before label is repeated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isSpreadCharacters

boolean isSpreadCharacters()
                           throws IOException,
                                  AutomationException
Indicates whether to spread label characters along line feature.

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.

setSpreadCharacters

void setSpreadCharacters(boolean flag)
                         throws IOException,
                                AutomationException
Indicates whether to spread label characters along line feature.

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.

getMaximumCharacterSpacing

double getMaximumCharacterSpacing()
                                  throws IOException,
                                         AutomationException
The character spacing may be increased upto this limit.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setMaximumCharacterSpacing

void setMaximumCharacterSpacing(double spacing)
                                throws IOException,
                                       AutomationException
The character spacing may be increased upto this limit.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isSpreadWords

boolean isSpreadWords()
                      throws IOException,
                             AutomationException
Indicates whether to spread words along line feature.

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.

setSpreadWords

void setSpreadWords(boolean flag)
                    throws IOException,
                           AutomationException
Indicates whether to spread words along line feature.

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.

getMaximumWordSpacing

double getMaximumWordSpacing()
                             throws IOException,
                                    AutomationException
The word spacing may be increased upto this limit.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setMaximumWordSpacing

void setMaximumWordSpacing(double spacing)
                           throws IOException,
                                  AutomationException
The word spacing may be increased upto this limit.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getPreferredEndOfStreetClearance

double getPreferredEndOfStreetClearance()
                                        throws IOException,
                                               AutomationException
Preferred clearance between street label and street end.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setPreferredEndOfStreetClearance

void setPreferredEndOfStreetClearance(double clearance)
                                      throws IOException,
                                             AutomationException
Preferred clearance between street label and street end.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getMinimumEndOfStreetClearance

double getMinimumEndOfStreetClearance()
                                      throws IOException,
                                             AutomationException
Minimum clearance between street label and street end.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setMinimumEndOfStreetClearance

void setMinimumEndOfStreetClearance(double clearance)
                                    throws IOException,
                                           AutomationException
Minimum clearance between street label and street end.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isCanStackLabel

boolean isCanStackLabel()
                        throws IOException,
                               AutomationException
Indicates whether to stack the label to obtain a better position.

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.

setCanStackLabel

void setCanStackLabel(boolean flag)
                      throws IOException,
                             AutomationException
Indicates whether to stack the label to obtain a better position.

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.

getLabelStackingProperties

IMaplexLabelStackingProperties getLabelStackingProperties()
                                                          throws IOException,
                                                                 AutomationException
The label stacking properties for a layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setLabelStackingProperties

void setLabelStackingProperties(IMaplexLabelStackingProperties props)
                                throws IOException,
                                       AutomationException
The label stacking properties for a layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isCanOverrunFeature

boolean isCanOverrunFeature()
                            throws IOException,
                                   AutomationException
Indicates whether to place the label over end of line or over polygon boundary.

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.

setCanOverrunFeature

void setCanOverrunFeature(boolean flag)
                          throws IOException,
                                 AutomationException
Indicates whether to place the label over end of line or over polygon boundary.

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.

getMaximumLabelOverrun

double getMaximumLabelOverrun()
                              throws IOException,
                                     AutomationException
Maximum distance that a label is allowed to overrun the end of its feature.

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.

setMaximumLabelOverrun

void setMaximumLabelOverrun(double distance)
                            throws IOException,
                                   AutomationException
Maximum distance that a label is allowed to overrun the end of its feature.

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.

isAllowAsymmetricOverrun

boolean isAllowAsymmetricOverrun()
                                 throws IOException,
                                        AutomationException
Indicates whether a label may overrun one side of a polygon feature.

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.

setAllowAsymmetricOverrun

void setAllowAsymmetricOverrun(boolean flag)
                               throws IOException,
                                      AutomationException
Indicates whether a label may overrun one side of a polygon feature.

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.

isCanAbbreviateLabel

boolean isCanAbbreviateLabel()
                             throws IOException,
                                    AutomationException
Indicates whether to abbreviate the label using an abbreviation dictionary.

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.

setCanAbbreviateLabel

void setCanAbbreviateLabel(boolean flag)
                           throws IOException,
                                  AutomationException
Indicates whether to abbreviate the label using an abbreviation dictionary.

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.

isCanTruncateLabel

boolean isCanTruncateLabel()
                           throws IOException,
                                  AutomationException
Indicates whether to truncate the label using an algorithm.

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.

setCanTruncateLabel

void setCanTruncateLabel(boolean flag)
                         throws IOException,
                                AutomationException
Indicates whether to truncate the label using an algorithm.

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.

isCanReduceFontSize

boolean isCanReduceFontSize()
                            throws IOException,
                                   AutomationException
Indicates whether to reduce the size of the font.

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.

setCanReduceFontSize

void setCanReduceFontSize(boolean flag)
                          throws IOException,
                                 AutomationException
Indicates whether to reduce the size of the font.

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.

setFontHeightReductionLimit

void setFontHeightReductionLimit(double limit)
                                 throws IOException,
                                        AutomationException
The font may be reduced in height until this limit is reached.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getFontHeightReductionLimit

double getFontHeightReductionLimit()
                                   throws IOException,
                                          AutomationException
The font may be reduced in height until this limit is reached.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setFontHeightReductionStep

void setFontHeightReductionStep(double step)
                                throws IOException,
                                       AutomationException
This is the step interval for font height reduction.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getFontHeightReductionStep

double getFontHeightReductionStep()
                                  throws IOException,
                                         AutomationException
This is the step interval for font height reduction.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setFontWidthReductionLimit

void setFontWidthReductionLimit(double limit)
                                throws IOException,
                                       AutomationException
The font may be reduced in width until this limit is reached.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getFontWidthReductionLimit

double getFontWidthReductionLimit()
                                  throws IOException,
                                         AutomationException
The font may be reduced in width until this limit is reached.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setFontWidthReductionStep

void setFontWidthReductionStep(double step)
                               throws IOException,
                                      AutomationException
This is the step interval for font width reduction.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getFontWidthReductionStep

double getFontWidthReductionStep()
                                 throws IOException,
                                        AutomationException
This is the step interval for font width reduction.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isNeverRemoveLabel

boolean isNeverRemoveLabel()
                           throws IOException,
                                  AutomationException
Indicates whether to not remove the label if no position is found.

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.

setNeverRemoveLabel

void setNeverRemoveLabel(boolean flag)
                         throws IOException,
                                AutomationException
Indicates whether to not remove the label if no position is found.

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.

getLabelPriority

int getLabelPriority()
                     throws IOException,
                            AutomationException
Label prority controls approximate placement order.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setLabelPriority

void setLabelPriority(int priority)
                      throws IOException,
                             AutomationException
Label prority controls approximate placement order.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getFeatureWeight

int getFeatureWeight()
                     throws IOException,
                            AutomationException
Feature weight controls which features may be overlapped and to what extent.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setFeatureWeight

void setFeatureWeight(int weight)
                      throws IOException,
                             AutomationException
Feature weight controls which features may be overlapped and to what extent.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setPolygonBoundaryWeight

void setPolygonBoundaryWeight(int weight)
                              throws IOException,
                                     AutomationException
Feature Weight for the boundary of the polygon.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getPolygonBoundaryWeight

int getPolygonBoundaryWeight()
                             throws IOException,
                                    AutomationException
Feature Weight for the boundary of the polygon.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isCanRemoveOverlappingLabel

boolean isCanRemoveOverlappingLabel()
                                    throws IOException,
                                           AutomationException
Indicates whether to remove the label if it overlaps with other labels.

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.

setCanRemoveOverlappingLabel

void setCanRemoveOverlappingLabel(boolean flag)
                                  throws IOException,
                                         AutomationException
Indicates whether to remove the label if it overlaps with other labels.

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.

isThinDuplicateLabels

boolean isThinDuplicateLabels()
                              throws IOException,
                                     AutomationException
Indicates whether to remove duplicate labels that lie within a specified distance of each other.

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.

setThinDuplicateLabels

void setThinDuplicateLabels(boolean flag)
                            throws IOException,
                                   AutomationException
Indicates whether to remove duplicate labels that lie within a specified distance of each other.

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.

getThinningDistance

double getThinningDistance()
                           throws IOException,
                                  AutomationException
Distance used to control the thinning of duplicate labels.

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.

setThinningDistance

void setThinningDistance(double distance)
                         throws IOException,
                                AutomationException
Distance used to control the thinning of duplicate labels.

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.

isGraticuleAlignment

boolean isGraticuleAlignment()
                             throws IOException,
                                    AutomationException
Indicates whether to enable graticule alignment.

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.

setGraticuleAlignment

void setGraticuleAlignment(boolean flag)
                           throws IOException,
                                  AutomationException
Indicates whether to enable graticule alignment.

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.

getOffsetAlongLineProperties

IMaplexOffsetAlongLineProperties getOffsetAlongLineProperties()
                                                              throws IOException,
                                                                     AutomationException
The offset along line properties for a layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setOffsetAlongLineProperties

void setOffsetAlongLineProperties(IMaplexOffsetAlongLineProperties props)
                                  throws IOException,
                                         AutomationException
The offset along line properties for a layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getRotationProperties

IMaplexRotationProperties getRotationProperties()
                                                throws IOException,
                                                       AutomationException
The label rotation properties for a layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setRotationProperties

void setRotationProperties(IMaplexRotationProperties props)
                           throws IOException,
                                  AutomationException
The label rotation properties for a layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getDictionaryName

String getDictionaryName()
                         throws IOException,
                                AutomationException
Name of the abbreviations dictionary referenced by this layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDictionaryName

void setDictionaryName(String text)
                       throws IOException,
                              AutomationException
Name of the abbreviations dictionary referenced by this layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isAlignLabelToLineDirection

boolean isAlignLabelToLineDirection()
                                    throws IOException,
                                           AutomationException
Indicates whether to align the label with the label direction so the label may appear upside down.

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.

setAlignLabelToLineDirection

void setAlignLabelToLineDirection(boolean flag)
                                  throws IOException,
                                         AutomationException
Indicates whether to align the label with the label direction so the label may appear upside down.

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.

isBackgroundLabel

boolean isBackgroundLabel()
                          throws IOException,
                                 AutomationException
Indicates whether to place the label first and allow other labels to be placed over it.

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.

setBackgroundLabel

void setBackgroundLabel(boolean flag)
                        throws IOException,
                               AutomationException
Indicates whether to place the label first and allow other labels to be placed over it.

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.

getMinimumSizeForLabeling

double getMinimumSizeForLabeling()
                                 throws IOException,
                                        AutomationException
Specifies a minimum size of a line or area feature for it to be labeled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setMinimumSizeForLabeling

void setMinimumSizeForLabeling(double size)
                               throws IOException,
                                      AutomationException
Specifies a minimum size of a line or area feature for it to be labeled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getLabelBuffer

int getLabelBuffer()
                   throws IOException,
                          AutomationException
Increase buffer to stop labels from being placed too close to each other.

Product Availability

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

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

setLabelBuffer

void setLabelBuffer(int buffer)
                    throws IOException,
                           AutomationException
Increase buffer to stop labels from being placed too close to each other.

Product Availability

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

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

getFeatureBuffer

int getFeatureBuffer()
                     throws IOException,
                            AutomationException
Increase buffer around a point feature to stop labels from being placed too close to the feature.

Product Availability

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

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

setFeatureBuffer

void setFeatureBuffer(int buffer)
                      throws IOException,
                             AutomationException
Increase buffer around a point feature to stop labels from being placed too close to the feature.

Product Availability

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

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