Package com.esri.arcgisruntime.mapping.labeling

Enum LabelMultipartStrategy

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<LabelMultipartStrategy>
    public enum LabelMultipartStrategy
extends java.lang.Enum<LabelMultipartStrategy>
    The strategy for the number of labels to be placed on a multipart feature.
    Since:
    100.11.0

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      AUTOMATIC
      Labeling will use the default distribution of labels across multipart features.
      LABEL_LARGEST
      If a feature consists of multiple parts, only the largest one will be assigned a label.
      LABEL_PER_FEATURE
      One label per feature, but not supported yet in runtime.
      LABEL_PER_PART
      If a feature consists of multiple geometries, each geometry will be assigned a label.
      LABEL_PER_SEGMENT
      One label per segment, but not supported yet in runtime.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static LabelMultipartStrategy valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static LabelMultipartStrategy[] 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 LabelMultipartStrategy AUTOMATIC
        Labeling will use the default distribution of labels across multipart features.

        This depends on Feature type:

        Since:
        100.11.0

      • LABEL_LARGEST

        public static final LabelMultipartStrategy LABEL_LARGEST
        If a feature consists of multiple parts, only the largest one will be assigned a label.

        If a line feature consists of multiple part geometries, or a polygon feature consists of multiple ring geometries, only the largest one will be assigned a label.

        If the largest part of the feature is not currently visible on the MapView, then the label will not be visible. It will not automatically move to the largest visible part.

        Since:
        100.11.0

      • LABEL_PER_FEATURE

        public static final LabelMultipartStrategy LABEL_PER_FEATURE
        One label per feature, but not supported yet in runtime.

        The intended use is to place one label to represent each feature, even if the feature is made up of multiple parts, for example placing a single label at the center of a group of point parts, not necessarily at the position of any individual part.

        Warning: This value can be set when labeling is authored in ArcGIS Pro, but is not supported yet in runtime. If used, the placement will be as for LABEL_PER_PART.

        Since:
        100.11.0

      • LABEL_PER_PART

        public static final LabelMultipartStrategy LABEL_PER_PART
        If a feature consists of multiple geometries, each geometry will be assigned a label.

        If a line feature consists of multiple line geometries, or a polygon feature consists of multiple ring geometries, each geometry will be assigned a label.

        Since:
        100.11.0

      • LABEL_PER_SEGMENT

        public static final LabelMultipartStrategy LABEL_PER_SEGMENT
        One label per segment, but not supported yet in runtime.

        The intended use is to place a label on each segment of each line geometry.

        Warning: This value can be set when labeling is authored in ArcGIS Pro, but is not supported yet in runtime. If used, the placement will be as for LABEL_PER_PART.

        Since:
        100.11.0

    • Method Detail

      • values

        public static LabelMultipartStrategy[] 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 (LabelMultipartStrategy c : LabelMultipartStrategy.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static LabelMultipartStrategy valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null