Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.arcgisservices

Class LabelingInfo

java.lang.Object
com.esri.arcgisruntime.arcgisservices.LabelingInfo
public final class LabelingInfo extends 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 Details

    • getLabelExpression

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