Package com.esri.arcgisruntime.mapping.labeling

Enum LabelBarrierWeight

java.lang.Object

java.lang.Enum<LabelBarrierWeight>

com.esri.arcgisruntime.mapping.labeling.LabelBarrierWeight

All Implemented Interfaces:

Serializable, Comparable<LabelBarrierWeight>

public enum LabelBarrierWeight
extends Enum<LabelBarrierWeight>

The weight of features when considered as barriers to labeling.

An AnnotationLayer or a DimensionLayer, which has no LabelDefinition of its own, can be added to a map's operational layers. Their features will be automatically considered by the labeling process, to block labels being placed overlapping the features. This LabelBarrierWeight property controls how much labels must avoid the layer's features.

Note: Other layer types, which have their own LabelDefinition, can also have their features treated as barriers, but this is controlled by their LabelDefinition.getFeatureBoundaryOverlapStrategy() and LabelDefinition.getFeatureInteriorOverlapStrategy() properties.

Since:

100.14.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
HIGH	The feature is an exclusion zone for labels.
LOW	The feature will be avoided by labels unless that's the only way they can be placed.
MEDIUM	The feature will be avoided by labels unless that's the only way they can be placed after trying some additional positions.
NONE	The feature will not act as an barrier to labels.

Method Summary

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

NONE

public static final LabelBarrierWeight NONE

The feature will not act as an barrier to labels.

Since:

100.14.0

LOW

public static final LabelBarrierWeight LOW

The feature will be avoided by labels unless that's the only way they can be placed.

Labels will still overlap this feature if that is the only way they can be placed.

Since:

100.14.0

MEDIUM

public static final LabelBarrierWeight MEDIUM

The feature will be avoided by labels unless that's the only way they can be placed after trying some additional positions.

Labels will still overlap this feature if that is the only way they can be placed. This is similar to LOW, but the labeling process can try additional intermediate alternative positions. Not all styles of labeling will have additional positions to try.

Since:

100.14.0

HIGH

public static final LabelBarrierWeight HIGH

The feature is an exclusion zone for labels.

Labels that overlap the feature will not be placed unless the label is using a deconfliction strategy of LabelDeconflictionStrategy.NONE or LabelDeconflictionStrategy.DYNAMIC_NEVER_REMOVE.

Since:

100.14.0

Method Detail

values

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

Returns:

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

valueOf

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