Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.ogc.kml

Class KmlLabelStyle

java.lang.Object
com.esri.arcgisruntime.ogc.kml.KmlColorStyle
com.esri.arcgisruntime.ogc.kml.KmlLabelStyle
public final class KmlLabelStyle extends KmlColorStyle
Specifies how the name of a KmlNode is draw, including color and style.

Controls how the <name> of a KmlNode is displayed. Determines color and scale of the name label. Corresponds to a <LabelStyle> is a KML document.

Since:
100.6.0

  • Constructor Details

    • KmlLabelStyle

      public KmlLabelStyle(Color labelColor, double scale)
      Constructs a KML label style with a specified label color and scale.
      Parameters:
      labelColor - color of the label. Default is Color.WHITE.
      scale - scale to resize the label. Default is 1.0.
      Throws:
      IllegalArgumentException - if labelColor is null
      IllegalArgumentException - if scale is negative
      Since:
      200.0.0

    • KmlLabelStyle

      @Deprecated(since="200.0.0", forRemoval=true) public KmlLabelStyle(int color, double scale)
      Deprecated, for removal: This API element is subject to removal in a future version.
      as of 200.0.0, replaced by KmlLabelStyle(Color, double)
      Constructs a KML label style with a specified label color and scale.
      Parameters:
      color - color of the label in 0xAARRGGBB format. Default is 0xFFFFFFFF.
      scale - scale to resize the label. Default is 1.0.
      Throws:
      IllegalArgumentException - if scale is negative
      Since:
      100.6.0

  • Method Details

    • getScale

      public double getScale()
      Gets the scale to resize the label. Default is 1.0.
      Returns:
      the scale to resize the label
      Since:
      100.6.0

    • setScale

      public void setScale(double scale)
      Sets the scale to resize the label.
      Parameters:
      scale - the scale to resize the label
      Throws:
      IllegalArgumentException - if scale is negative
      Since:
      100.6.0