Module com.esri.arcgisruntime

Package com.esri.arcgisruntime.mapping.labeling

Enum Class LabelGeometryStrategy

java.lang.Object

java.lang.Enum<LabelGeometryStrategy>

com.esri.arcgisruntime.mapping.labeling.LabelGeometryStrategy

All Implemented Interfaces:

Serializable, Comparable<LabelGeometryStrategy>, Constable

public enum LabelGeometryStrategy
extends Enum<LabelGeometryStrategy>

The strategy for how to use the geometry of the feature when calculating the label position.

Since:

200.3.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTOMATIC	Labeling will use the default LabelGeometryStrategy depending on the feature type.
USE_CLIPPED_GEOMETRY	The subset of the feature's geometry within the screen extent will be used to calculate the position of the label.
USE_GEOMETRY	The feature's entire geometry will be used to calculate the position of the label.

Method Summary

Modifier and Type	Method	Description
static LabelGeometryStrategy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LabelGeometryStrategy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

AUTOMATIC

public static final LabelGeometryStrategy AUTOMATIC

Labeling will use the default LabelGeometryStrategy depending on the feature type.

This behavior depends on Feature type:

• Polygon labels will use USE_GEOMETRY
• Line labels will use USE_CLIPPED_GEOMETRY.

Since:

200.3.0

USE_GEOMETRY

public static final LabelGeometryStrategy USE_GEOMETRY

The feature's entire geometry will be used to calculate the position of the label.

This may result in a label not being visible because the preferred location is outside the extent. For example, a line label placed at the start or end of the line might be off-screen if the start or end of the feature geometry are off-screen.

Since:

200.3.0

USE_CLIPPED_GEOMETRY

public static final LabelGeometryStrategy USE_CLIPPED_GEOMETRY

The subset of the feature's geometry within the screen extent will be used to calculate the position of the label.

The label is more likely to be visible on-screen, if there is room. However, the label may move position as the user pans the screen and different parts of the feature geometry are used to calculate the label position.

Since:

200.3.0

Method Details

values

public static LabelGeometryStrategy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static LabelGeometryStrategy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null