Package provided.owlMaps.components.overlay

Interface IGroundOverlay

All Superinterfaces:
IOptionedMapObject<provided.mixedData.MixedDataDictionary>, IVisibleMapObject
All Known Subinterfaces:
IGroundOverlayWrapped
public interface IGroundOverlay
extends IVisibleMapObject, IOptionedMapObject<provided.mixedData.MixedDataDictionary>
A rectangular image overlaid onto the map. Note: A ground overlay may only display when the map is oriented with north upward (bug in Google API?) IGroundOverlays only accept IGroupOverlayMouseEventType events.
Author:
swong

  • Method Details

    • getBounds

      ILatLngBounds getBounds()
      Get a COPY of the overlay's bounds
      Returns:
      An ILatLngBounds object

    • setBounds

      void setBounds​(ILatLngBounds bounds)
      Set the overlay's bounds
      Parameters:
      bounds - The new bounds as an ILatLngBounds object

    • getUrl

      java.lang.String getUrl()
      Get the URL of the displayed image
      Returns:
      A URL string

    • getOpacity

      double getOpacity()
      Get the current opacity level of the overlay
      Returns:
      The opacity level [0.0-1.0]

    • setOpacity

      void setOpacity​(double opacity)
      Set the overlay's opacity
      Parameters:
      opacity - The new opacity level [0.0-1.0]

    • setGroundOverlayMouseEvent

      void setGroundOverlayMouseEvent​(GroundOverlayMouseEventType eventType, java.util.function.Consumer<IMouseEvent> eventFn)
      Set the event
      Parameters:
      eventType - The type of event being set
      eventFn - The callback to use when the event is invoked.