Package provided.owlMaps.components.overlay

Interface IGroundOverlayOptions

All Superinterfaces:
IOptionsKeys, java.io.Serializable
public interface IGroundOverlayOptions
extends IOptionsKeys
Options for making ground overlays. Note: the opacity and clickable options must always be explicitly set because of a bug in the underlying Google API Javascript code that will leave those fields undefined if omitted.
Author:
swong

  • Field Summary

    Fields
    Modifier and Type Field Description
    static provided.mixedData.MixedDataKey<ILatLngBounds> BOUNDS
    The bounds of the overlay
    static provided.mixedData.MixedDataKey<java.lang.Boolean> CLICKABLE
    Indicates whether this Circle handles mouse events.
    static provided.mixedData.MixedDataKey<java.lang.Double> OPACITY
    The opacity of the overlay between 0.0 and 1.0.
    static java.util.UUID OPTIONS_ID
    Unique identifier for this class of options.
    static provided.mixedData.MixedDataKey<java.lang.String> URL
    The URL of the image to display
    static provided.mixedData.MixedDataKey<java.lang.Boolean> VISIBLE
    Whether this circle is visible on the map.

  • Method Summary

    Static Methods
    Modifier and Type Method Description
    static provided.mixedData.IMixedDataDictionary makeDefault()
    Make a dictionary of the default options for the component, including explicitly setting the opacity and clickable options to their default values.
    static IOptionsFiller makeOptionsFiller​(ICefUtils jsUtils)
    *FOR INTERNAL USE ONLY!!* OWLMAPS DEVELOPER CODE SHOULD *NOT* USE THIS METHOD! Factory to create the IOptionsFiller that converts the component options into their corresponding Javascript Google Map component options.

  • Field Details

    • OPTIONS_ID

      static final java.util.UUID OPTIONS_ID
      Unique identifier for this class of options. Always refer to this field by name and not by its value to ensure compatibility when the codebase is updated as the value of the field may change!

    • BOUNDS

      static final provided.mixedData.MixedDataKey<ILatLngBounds> BOUNDS
      The bounds of the overlay

    • CLICKABLE

      static final provided.mixedData.MixedDataKey<java.lang.Boolean> CLICKABLE
      Indicates whether this Circle handles mouse events. Defaults to true.

    • OPACITY

      static final provided.mixedData.MixedDataKey<java.lang.Double> OPACITY
      The opacity of the overlay between 0.0 and 1.0. Default = 1.0

    • URL

      static final provided.mixedData.MixedDataKey<java.lang.String> URL
      The URL of the image to display

    • VISIBLE

      static final provided.mixedData.MixedDataKey<java.lang.Boolean> VISIBLE
      Whether this circle is visible on the map. Defaults to true.

  • Method Details

    • makeDefault

      static provided.mixedData.IMixedDataDictionary makeDefault()
      Make a dictionary of the default options for the component, including explicitly setting the opacity and clickable options to their default values.
      Returns:
      A dictionary with any default options

    • makeOptionsFiller

      static IOptionsFiller makeOptionsFiller​(ICefUtils jsUtils)
      *FOR INTERNAL USE ONLY!!* OWLMAPS DEVELOPER CODE SHOULD *NOT* USE THIS METHOD! Factory to create the IOptionsFiller that converts the component options into their corresponding Javascript Google Map component options.
      Parameters:
      jsUtils - The IJsUtils created by the system
      Returns:
      An IOptionsFiller for this component's options.