Package com.trimblemaps.mapsdk.style.layers

Class BackgroundLayer

java.lang.Object
com.trimblemaps.mapsdk.style.layers.Layer
com.trimblemaps.mapsdk.style.layers.BackgroundLayer
@UiThread public class BackgroundLayer extends Layer
The background color or pattern of the map.

  • Constructor Details

    • BackgroundLayer

      public BackgroundLayer(String layerId)
      Creates a BackgroundLayer.
      Parameters:
      layerId - the id of the layer

  • Method Details

    • initialize

      protected void initialize(String layerId)

    • withProperties

      @NonNull public BackgroundLayer withProperties(@NonNull PropertyValue<?>... properties)
      Set a property or properties.
      Parameters:
      properties - the var-args properties
      Returns:
      This

    • getBackgroundColor

      @NonNull public PropertyValue<String> getBackgroundColor()
      Get the BackgroundColor property
      Returns:
      property wrapper value around String

    • getBackgroundColorAsInt

      @ColorInt public int getBackgroundColorAsInt()
      The color with which the background will be drawn.
      Returns:
      int representation of a rgba string color
      Throws:
      RuntimeException - thrown if property isn't a value

    • getBackgroundColorTransition

      @NonNull public TransitionOptions getBackgroundColorTransition()
      Get the BackgroundColor property transition options
      Returns:
      transition options for String

    • setBackgroundColorTransition

      public void setBackgroundColorTransition(@NonNull TransitionOptions options)
      Set the BackgroundColor property transition options
      Parameters:
      options - transition options for String

    • getBackgroundPattern

      @NonNull public PropertyValue<String> getBackgroundPattern()
      Get the BackgroundPattern property
      Returns:
      property wrapper value around String

    • getBackgroundPatternTransition

      @NonNull public TransitionOptions getBackgroundPatternTransition()
      Get the BackgroundPattern property transition options
      Returns:
      transition options for String

    • setBackgroundPatternTransition

      public void setBackgroundPatternTransition(@NonNull TransitionOptions options)
      Set the BackgroundPattern property transition options
      Parameters:
      options - transition options for String

    • getBackgroundOpacity

      @NonNull public PropertyValue<Float> getBackgroundOpacity()
      Get the BackgroundOpacity property
      Returns:
      property wrapper value around Float

    • getBackgroundOpacityTransition

      @NonNull public TransitionOptions getBackgroundOpacityTransition()
      Get the BackgroundOpacity property transition options
      Returns:
      transition options for Float

    • setBackgroundOpacityTransition

      public void setBackgroundOpacityTransition(@NonNull TransitionOptions options)
      Set the BackgroundOpacity property transition options
      Parameters:
      options - transition options for Float

    • finalize

      protected void finalize() throws Throwable
      Overrides:
      finalize in class Layer
      Throws:
      Throwable