com.esri.arcgis.carto
Interface IACLabelRenderer

All Superinterfaces:

Serializable

All Known Implementing Classes:

ACSimpleLabelRenderer, ACValueMapLabelRenderer

public interface IACLabelRenderer
extends Serializable

Provides access to members that control ArcIMS label renderer.

Product Availability

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

Method Summary

int	getFeatureWeight() The feature weight to prioritize the importance of features.
int	getHowManyLabels() Determines how often a feature will be labeled.
double	getLabelBufferRatio() The buffer range around the label where no other labels will overlap.
String	getLabelField() The name of the Field.
String	getLabelProperties() The label properties.
IACSymbol	getLabelSymbol() Text symbol used to draw the labels.
int	getLabelWeight() The label weight to prioritize the importance of labels.
int	getLineLabelPosition() Determines where on the line to place the label.
String	getRotationalAngles() The rotation angle of this label.
void	setFeatureWeight(int weight) The feature weight to prioritize the importance of features.
void	setHowManyLabels(int numLabels) Determines how often a feature will be labeled.
void	setLabelBufferRatio(double ratio) The buffer range around the label where no other labels will overlap.
void	setLabelField(String name) The name of the Field.
void	setLabelProperties(String props) The label properties.
void	setLabelSymbol(IACSymbol symbol) Text symbol used to draw the labels.
void	setLabelWeight(int weight) The label weight to prioritize the importance of labels.
void	setLineLabelPosition(int lineLabelPosition) Determines where on the line to place the label.
void	setRotationalAngles(String angles) The rotation angle of this label.

Method Detail

getLabelSymbol

IACSymbol getLabelSymbol()
                         throws IOException,
                                AutomationException

Text symbol used to draw the labels.

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelSymbol

void setLabelSymbol(IACSymbol symbol)
                    throws IOException,
                           AutomationException

Text symbol used to draw the labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

symbol - A reference to a com.esri.arcgis.carto.IACSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelField

String getLabelField()
                     throws IOException,
                            AutomationException

The name of the Field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelField

void setLabelField(String name)
                   throws IOException,
                          AutomationException

The name of the Field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureWeight

int getFeatureWeight()
                     throws IOException,
                            AutomationException

The feature weight to prioritize the importance of features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.carto.acLabelWeight constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureWeight

void setFeatureWeight(int weight)
                      throws IOException,
                             AutomationException

The feature weight to prioritize the importance of features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

weight - A com.esri.arcgis.carto.acLabelWeight constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelWeight

int getLabelWeight()
                   throws IOException,
                          AutomationException

The label weight to prioritize the importance of labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.carto.acLabelWeight constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelWeight

void setLabelWeight(int weight)
                    throws IOException,
                           AutomationException

The label weight to prioritize the importance of labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

weight - A com.esri.arcgis.carto.acLabelWeight constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelBufferRatio

double getLabelBufferRatio()
                           throws IOException,
                                  AutomationException

The buffer range around the label where no other labels will overlap.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The ratio

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelBufferRatio

void setLabelBufferRatio(double ratio)
                         throws IOException,
                                AutomationException

The buffer range around the label where no other labels will overlap.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

ratio - The ratio (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelProperties

String getLabelProperties()
                          throws IOException,
                                 AutomationException

The label properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The props

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelProperties

void setLabelProperties(String props)
                        throws IOException,
                               AutomationException

The label properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

props - The props (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRotationalAngles

String getRotationalAngles()
                           throws IOException,
                                  AutomationException

The rotation angle of this label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The angles

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRotationalAngles

void setRotationalAngles(String angles)
                         throws IOException,
                                AutomationException

The rotation angle of this label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

angles - The angles (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHowManyLabels

int getHowManyLabels()
                     throws IOException,
                            AutomationException

Determines how often a feature will be labeled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.carto.acNumLabels constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHowManyLabels

void setHowManyLabels(int numLabels)
                      throws IOException,
                             AutomationException

Determines how often a feature will be labeled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

numLabels - A com.esri.arcgis.carto.acNumLabels constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLineLabelPosition

int getLineLabelPosition()
                         throws IOException,
                                AutomationException

Determines where on the line to place the label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.carto.acLineLabelPosition constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLineLabelPosition

void setLineLabelPosition(int lineLabelPosition)
                          throws IOException,
                                 AutomationException

Determines where on the line to place the label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

lineLabelPosition - A com.esri.arcgis.carto.acLineLabelPosition constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.