Package provided.owlMaps.components.marker

Interface IMarkerOptions

All Superinterfaces:
IOptionsKeys, java.io.Serializable
public interface IMarkerOptions
extends IOptionsKeys
Options for making markers
Author:
swong

  • Field Summary

    Fields
    Modifier and Type Field Description
    static provided.mixedData.MixedDataKey<java.awt.geom.Point2D> ANCHOR_POINT
    The offset from the marker's position to the tip of an InfoWindow that has been opened with the marker as anchor.
    static provided.mixedData.MixedDataKey<java.lang.Boolean> CLICKABLE
    If true, the marker receives mouse and touch events.
    static provided.mixedData.MixedDataKey<java.lang.Boolean> CROSS_ON_DRAG
    If false, disables cross that appears beneath the marker when dragging.
    static provided.mixedData.MixedDataKey<java.lang.String> CURSOR
    Mouse cursor to show on hover
    static provided.mixedData.MixedDataKey<java.lang.Boolean> DRAGGABLE
    If true, the marker can be dragged.
    static provided.mixedData.MixedDataKey<java.lang.String> ICON
    Icon for the foreground.
    static provided.mixedData.MixedDataKey<IMarkerLabel> LABEL
    Adds a label to the marker specified as a dictionary of IMarkerLLabelOptions
    static provided.mixedData.MixedDataKey<java.lang.Double> OPACITY
    The marker's opacity between 0.0 and 1.0.
    static provided.mixedData.MixedDataKey<java.lang.Boolean> OPTIMIZED
    Optimization renders many markers as a single static element.
    static java.util.UUID OPTIONS_ID
    Unique identifier for this class of options.
    static provided.mixedData.MixedDataKey<ILatLng> POSITION
    Marker position.
    static provided.mixedData.MixedDataKey<java.lang.String> TITLE
    Rollover text
    static provided.mixedData.MixedDataKey<java.lang.Boolean> VISIBLE
    If true, the marker is visible.
    static provided.mixedData.MixedDataKey<java.lang.Double> ZINDEX
    All markers are displayed on the map in order of their zIndex, with higher values displaying in front of markers with lower values.

  • Method Summary

    Static Methods
    Modifier and Type Method Description
    static provided.mixedData.IMixedDataDictionary makeDefault()
    Make a dictionary of the default options for the component.
    static IOptionsFiller makeOptionsFiller​(ICefUtils cefUtils)
    *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!

    • ANCHOR_POINT

      static final provided.mixedData.MixedDataKey<java.awt.geom.Point2D> ANCHOR_POINT
      The offset from the marker's position to the tip of an InfoWindow that has been opened with the marker as anchor.

    • CLICKABLE

      static final provided.mixedData.MixedDataKey<java.lang.Boolean> CLICKABLE
      If true, the marker receives mouse and touch events. Default value is true.

    • CROSS_ON_DRAG

      static final provided.mixedData.MixedDataKey<java.lang.Boolean> CROSS_ON_DRAG
      If false, disables cross that appears beneath the marker when dragging. This option is true by default.

    • CURSOR

      static final provided.mixedData.MixedDataKey<java.lang.String> CURSOR
      Mouse cursor to show on hover

    • DRAGGABLE

      static final provided.mixedData.MixedDataKey<java.lang.Boolean> DRAGGABLE
      If true, the marker can be dragged. Default value is false.

    • ICON

      static final provided.mixedData.MixedDataKey<java.lang.String> ICON
      Icon for the foreground. URL for the icon image

    • LABEL

      static final provided.mixedData.MixedDataKey<IMarkerLabel> LABEL
      Adds a label to the marker specified as a dictionary of IMarkerLLabelOptions

    • OPACITY

      static final provided.mixedData.MixedDataKey<java.lang.Double> OPACITY
      The marker's opacity between 0.0 and 1.0.

    • OPTIMIZED

      static final provided.mixedData.MixedDataKey<java.lang.Boolean> OPTIMIZED
      Optimization renders many markers as a single static element. Optimized rendering is enabled by default. Disable optimized rendering for animated GIFs or PNGs, or when each marker must be rendered as a separate DOM element (advanced usage only).

    • POSITION

      static final provided.mixedData.MixedDataKey<ILatLng> POSITION
      Marker position. Required.

    • TITLE

      static final provided.mixedData.MixedDataKey<java.lang.String> TITLE
      Rollover text

    • VISIBLE

      static final provided.mixedData.MixedDataKey<java.lang.Boolean> VISIBLE
      If true, the marker is visible. Defaults to false

    • ZINDEX

      static final provided.mixedData.MixedDataKey<java.lang.Double> ZINDEX
      All markers are displayed on the map in order of their zIndex, with higher values displaying in front of markers with lower values. By default, markers are displayed according to their vertical position on screen, with lower markers appearing in front of markers further up the screen.

  • Method Details

    • makeDefault

      static provided.mixedData.IMixedDataDictionary makeDefault()
      Make a dictionary of the default options for the component.
      Returns:
      A dictionary with any default options

    • makeOptionsFiller

      static IOptionsFiller makeOptionsFiller​(ICefUtils cefUtils)
      *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:
      cefUtils - The IJsUtils created by the system
      Returns:
      An IOptionsFiller for this component's options.