Enum Class LabelBarrierWeight
- All Implemented Interfaces:
Serializable
,Comparable<LabelBarrierWeight>
,Constable
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
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionThe feature is an exclusion zone for labels.The feature will be avoided by labels unless that's the only way they can be placed.The feature will be avoided by labels unless that's the only way they can be placed after trying some additional positions.The feature will not act as a barrier to labels. -
Method Summary
Modifier and TypeMethodDescriptionstatic LabelBarrierWeight
Returns the enum constant of this class with the specified name.static LabelBarrierWeight[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
NONE
The feature will not act as a barrier to labels.- Since:
- 100.14.0
-
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
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
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
orLabelDeconflictionStrategy.DYNAMIC_NEVER_REMOVE
.- Since:
- 100.14.0
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-