Package com.esri.arcgisruntime.mapping.labeling

Enum LabelDeconflictionStrategy

java.lang.Object

java.lang.Enum<LabelDeconflictionStrategy>

com.esri.arcgisruntime.mapping.labeling.LabelDeconflictionStrategy

All Implemented Interfaces:

Serializable, Comparable<LabelDeconflictionStrategy>

public enum LabelDeconflictionStrategy
extends Enum<LabelDeconflictionStrategy>

The strategy for moving labels to avoid overlapping point symbols or higher priority labels.

Since:

100.11.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTOMATIC	The label will use the default deconfliction strategy (STATIC).
DYNAMIC	Place the label in the preferred location, but move to an alternative location to not overlap higher priority labels or feature/graphic symbols.
DYNAMIC_NEVER_REMOVE	Place the label in the preferred location, but move to an alternative location to minimize overlapping higher priority labels or feature/graphic symbols.
NONE	Place the label in the preferred location, regardless of overlaps with other features, graphics or labels.
STATIC	Place the label in the preferred location, unless it would overlap a higher priority label or feature/graphic symbol.

Method Summary

Modifier and Type	Method	Description
static LabelDeconflictionStrategy	valueOf(String name)	Returns the enum constant of this type with the specified name.
static LabelDeconflictionStrategy[]	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 LabelDeconflictionStrategy AUTOMATIC

The label will use the default deconfliction strategy (STATIC).

This value corresponds to no value being specified for a LabelDefinition.getDeconflictionStrategy() property.

Since:

100.11.0

DYNAMIC

public static final LabelDeconflictionStrategy DYNAMIC

Place the label in the preferred location, but move to an alternative location to not overlap higher priority labels or feature/graphic symbols.

This label is placed only if it can be moved to a location that will not overlap a higher priority label.

Since:

100.11.0

NONE

public static final LabelDeconflictionStrategy NONE

Place the label in the preferred location, regardless of overlaps with other features, graphics or labels.

Since:

100.11.0

STATIC

public static final LabelDeconflictionStrategy STATIC

Place the label in the preferred location, unless it would overlap a higher priority label or feature/graphic symbol.

If it overlaps a lower priority label, then the lower priority label may disappear or move (depending on its LabelDefinition.getDeconflictionStrategy()). If this label overlaps a higher priority label, then this label is not placed.

Since:

100.11.0

DYNAMIC_NEVER_REMOVE

public static final LabelDeconflictionStrategy DYNAMIC_NEVER_REMOVE

Place the label in the preferred location, but move to an alternative location to minimize overlapping higher priority labels or feature/graphic symbols.

This label is always placed, even if it overlaps a higher priority label.

Since:

100.12.0

Method Detail

values

public static LabelDeconflictionStrategy[] 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 (LabelDeconflictionStrategy c : LabelDeconflictionStrategy.values())
    System.out.println(c);

Returns:

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

valueOf

public static LabelDeconflictionStrategy 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