com.esri.arcgis.carto
Interface IPointPlacementPriorities

All Superinterfaces:

Serializable

All Known Implementing Classes:

PointPlacementPriorities

public interface IPointPlacementPriorities
extends Serializable

Provides access to members that control placement position priorities for point labels.

Remarks

The IPointLabelPlacementPriorities interface maintains information about the placement alternatives of labels relative to point features. For example, use this interface to specify whether labels can be placed abobe, below, left or right to points.

Each available position is assigned a weight between 0-9. Zero (0) means that this position is not to be considered at all (blocked), whereas a position assigned the weight one (1) would be tried before two (2) and so on.

Product Availability

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

See Also:

IBasicOverposterLayerProperties

Method Summary

int	getAboveCenter() Label position priority for above and center (0-9).
int	getAboveLeft() Label position priority for above and to the left (0-9).
int	getAboveRight() Label position priority for above and to the right (0-9).
int	getBelowCenter() Label position priority for below and center (0-9).
int	getBelowLeft() Label position priority for below and to the left (0-9).
int	getBelowRight() Label position priority for below and to the right (0-9).
int	getCenterLeft() Label position priority for center and to the left (0-9).
int	getCenterRight() Label position priority for center and to the right (0-9).
void	setAboveCenter(int priority) Label position priority for above and center (0-9).
void	setAboveLeft(int priority) Label position priority for above and to the left (0-9).
void	setAboveRight(int priority) Label position priority for above and to the right (0-9).
void	setBelowCenter(int priority) Label position priority for below and center (0-9).
void	setBelowLeft(int priority) Label position priority for below and to the left (0-9).
void	setBelowRight(int priority) Label position priority for below and to the right (0-9).
void	setCenterLeft(int priority) Label position priority for center and to the left (0-9).
void	setCenterRight(int priority) Label position priority for center and to the right (0-9).

Method Detail

getAboveLeft

int getAboveLeft()
                 throws IOException,
                        AutomationException

Label position priority for above and to the left (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

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.

setAboveLeft

void setAboveLeft(int priority)
                  throws IOException,
                         AutomationException

Label position priority for above and to the left (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

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.

getAboveCenter

int getAboveCenter()
                   throws IOException,
                          AutomationException

Label position priority for above and center (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

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.

setAboveCenter

void setAboveCenter(int priority)
                    throws IOException,
                           AutomationException

Label position priority for above and center (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

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.

getAboveRight

int getAboveRight()
                  throws IOException,
                         AutomationException

Label position priority for above and to the right (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

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.

setAboveRight

void setAboveRight(int priority)
                   throws IOException,
                          AutomationException

Label position priority for above and to the right (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

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.

getCenterRight

int getCenterRight()
                   throws IOException,
                          AutomationException

Label position priority for center and to the right (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

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.

setCenterRight

void setCenterRight(int priority)
                    throws IOException,
                           AutomationException

Label position priority for center and to the right (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

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.

getBelowRight

int getBelowRight()
                  throws IOException,
                         AutomationException

Label position priority for below and to the right (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

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.

setBelowRight

void setBelowRight(int priority)
                   throws IOException,
                          AutomationException

Label position priority for below and to the right (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

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.

getBelowCenter

int getBelowCenter()
                   throws IOException,
                          AutomationException

Label position priority for below and center (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

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.

setBelowCenter

void setBelowCenter(int priority)
                    throws IOException,
                           AutomationException

Label position priority for below and center (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

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.

getBelowLeft

int getBelowLeft()
                 throws IOException,
                        AutomationException

Label position priority for below and to the left (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

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.

setBelowLeft

void setBelowLeft(int priority)
                  throws IOException,
                         AutomationException

Label position priority for below and to the left (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

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.

getCenterLeft

int getCenterLeft()
                  throws IOException,
                         AutomationException

Label position priority for center and to the left (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

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.

setCenterLeft

void setCenterLeft(int priority)
                   throws IOException,
                          AutomationException

Label position priority for center and to the left (0-9).

Description

Valid range is 0-9. 0 means that the position should not be considered at all for label placement. 1 means that the position is has highest priority for placement, and 9 means that the position has lowest priority.

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.