Package com.esri.arcgisruntime.arcgisservices

Class LabelingInfo

  • public final class LabelingInfo
extends java.lang.Object
    An object that defines the text, appearance and position of labels for features for a given scale range.

    Each LabelingInfo specifies:

    • Which features are covered by the definition, by applying the getWhere() SQL constraint
    • What text should be displayed, based on the individual feature's attributes and the getLabelExpression() formula
    • How the text should appear, using the getSymbol()
    • Where the text should appear, with respect to its feature, using the getLabelPlacement()
    Since:
    100.0.0

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getLabelExpression()
      Gets the expression that specifies what text is used for the label.
      LabelingPlacement getLabelPlacement()
      Gets the placement of the label.
      double getMaxScale()
      Gets the maximum scale to display labels at.
      double getMinScale()
      Gets the minimum scale to display labels at.
      TextSymbol getSymbol()
      Gets the default symbol for this service.
      java.lang.String getWhere()
      Gets the feature filter expression.
      boolean isUseCodedValues()
      Specifies whether or not the labelling is using coded values.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getLabelExpression

        public java.lang.String getLabelExpression()
        Gets the expression that specifies what text is used for the label.
        Returns:
        the label expression
        Since:
        100.0.0

      • getLabelPlacement

        public LabelingPlacement getLabelPlacement()
        Gets the placement of the label.
        Returns:
        the label placement
        Since:
        100.0.0

      • getMinScale

        public double getMinScale()
        Gets the minimum scale to display labels at.
        Returns:
        the min scale
        Since:
        100.0.0

      • getMaxScale

        public double getMaxScale()
        Gets the maximum scale to display labels at.
        Returns:
        the max scale
        Since:
        100.0.0

      • getSymbol

        public TextSymbol getSymbol()
        Gets the default symbol for this service.
        Returns:
        the symbol
        Since:
        100.0.0

      • getWhere

        public java.lang.String getWhere()
        Gets the feature filter expression. Only those features are labelled which satisfy the where clause condition.
        Returns:
        the where clause condition
        Since:
        100.0.0

      • isUseCodedValues

        public boolean isUseCodedValues()
        Specifies whether or not the labelling is using coded values.
        Returns:
        true if the labelling uses coded values, false otherwise
        Since:
        100.0.0