Class FillOptions

java.lang.Object
com.trimblemaps.mapsdk.plugins.annotation.Options<Fill>
com.trimblemaps.mapsdk.plugins.annotation.FillOptions

public class FillOptions extends Options<Fill>
Builder class from which a fill is created.
  • Constructor Details

    • FillOptions

      public FillOptions()
  • Method Details

    • withFillOpacity

      public FillOptions withFillOpacity(Float fillOpacity)
      Set fill-opacity to initialise the fill with.

      The opacity of the entire fill layer. In contrast to the PropertyFactory.fillColor(int), this value will also affect the 1px stroke around the fill, if the stroke is used.

      Parameters:
      fillOpacity - the fill-opacity value
      Returns:
      this
    • getFillOpacity

      public Float getFillOpacity()
      Get the current configured fill-opacity for the fill

      The opacity of the entire fill layer. In contrast to the PropertyFactory.fillColor(int), this value will also affect the 1px stroke around the fill, if the stroke is used.

      Returns:
      fillOpacity value
    • withFillColor

      public FillOptions withFillColor(String fillColor)
      Set fill-color to initialise the fill with.

      The color of the filled part of this layer. This color can be specified as `rgba` with an alpha component and the color's opacity will not affect the opacity of the 1px stroke, if it is used.

      Parameters:
      fillColor - the fill-color value
      Returns:
      this
    • getFillColor

      public String getFillColor()
      Get the current configured fill-color for the fill

      The color of the filled part of this layer. This color can be specified as `rgba` with an alpha component and the color's opacity will not affect the opacity of the 1px stroke, if it is used.

      Returns:
      fillColor value
    • withFillOutlineColor

      public FillOptions withFillOutlineColor(String fillOutlineColor)
      Set fill-outline-color to initialise the fill with.

      The outline color of the fill. Matches the value of PropertyFactory.fillColor(int) if unspecified.

      Parameters:
      fillOutlineColor - the fill-outline-color value
      Returns:
      this
    • getFillOutlineColor

      public String getFillOutlineColor()
      Get the current configured fill-outline-color for the fill

      The outline color of the fill. Matches the value of PropertyFactory.fillColor(int) if unspecified.

      Returns:
      fillOutlineColor value
    • withFillPattern

      public FillOptions withFillPattern(String fillPattern)
      Set fill-pattern to initialise the fill with.

      Name of image in sprite to use for drawing image fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.

      Parameters:
      fillPattern - the fill-pattern value
      Returns:
      this
    • getFillPattern

      public String getFillPattern()
      Get the current configured fill-pattern for the fill

      Name of image in sprite to use for drawing image fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.

      Returns:
      fillPattern value
    • withLatLngs

      public FillOptions withLatLngs(List<List<com.trimblemaps.mapsdk.geometry.LatLng>> latLngs)
      Set a list of lists of LatLng for the fill, which represents the locations of the fill on the map
      Parameters:
      latLngs - a list of a lists of the locations of the line in a longitude and latitude pairs
      Returns:
      this
    • getLatLngs

      public List<List<com.trimblemaps.mapsdk.geometry.LatLng>> getLatLngs()
      Get a list of lists of LatLng for the fill, which represents the locations of the fill on the map
      Returns:
      a list of a lists of the locations of the line in a longitude and latitude pairs
    • withGeometry

      public FillOptions withGeometry(com.trimblemaps.geojson.Polygon geometry)
      Set the geometry of the fill, which represents the location of the fill on the map
      Parameters:
      geometry - the location of the fill
      Returns:
      this
    • getGeometry

      public com.trimblemaps.geojson.Polygon getGeometry()
      Get the geometry of the fill, which represents the location of the fill on the map
      Returns:
      the location of the fill
    • getDraggable

      public boolean getDraggable()
      Returns whether this fill is draggable, meaning it can be dragged across the screen when touched and moved.
      Returns:
      draggable when touched
    • withDraggable

      public FillOptions withDraggable(boolean draggable)
      Set whether this fill should be draggable, meaning it can be dragged across the screen when touched and moved.
      Parameters:
      draggable - should be draggable
    • withData

      public FillOptions withData(@Nullable com.google.gson.JsonElement jsonElement)
      Set the arbitrary json data of the annotation.
      Parameters:
      jsonElement - the arbitrary json element data
    • getData

      @Nullable public com.google.gson.JsonElement getData()
      Get the arbitrary json data of the annotation.
      Returns:
      the arbitrary json object data if set, else null