Package com.esri.arcgisruntime.mapping.labeling

Enum LabelOverrunStrategy

java.lang.Object

java.lang.Enum<LabelOverrunStrategy>

com.esri.arcgisruntime.mapping.labeling.LabelOverrunStrategy

All Implemented Interfaces:

Serializable, Comparable<LabelOverrunStrategy>

public enum LabelOverrunStrategy
extends Enum<LabelOverrunStrategy>

The strategy for whether a label should be visible at viewing scales where the feature is too small for the label to fit.

Since:

100.11.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALLOW	The label can run past the ends of its line geometry or edges or its polygon geometry.
AUTOMATIC	The label will use the default overrun behavior which depends on the object being overrun.
NONE	The label cannot run past the ends of its line geometry or edges of its polygon geometry.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AUTOMATIC

public static final LabelOverrunStrategy AUTOMATIC

The label will use the default overrun behavior which depends on the object being overrun. This value corresponds to no value being specified for the LabelDefinition.getOverrunStrategy() property.

Since:

100.11.0

NONE

public static final LabelOverrunStrategy NONE

The label cannot run past the ends of its line geometry or edges of its polygon geometry.

Since:

100.11.0

ALLOW

public static final LabelOverrunStrategy ALLOW

The label can run past the ends of its line geometry or edges or its polygon geometry.

Since:

100.11.0

Method Detail

values

public static LabelOverrunStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LabelOverrunStrategy c : LabelOverrunStrategy.values())
    System.out.println(c);

Returns:

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

valueOf

public static LabelOverrunStrategy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null