Package provided.owlMaps.map.data

Interface IMapDataStyleOptions

All Superinterfaces:
IOptionsKeys, java.io.Serializable
public interface IMapDataStyleOptions
extends IOptionsKeys
These options specify the way a Feature should appear when displayed on a map.
Author:
swong

  • Field Summary

    Fields
    Modifier and Type Field Description
    static provided.mixedData.MixedDataKey<java.lang.Boolean> CLICKABLE
    If true, the marker receives mouse and touch events.
    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 object can be dragged across the map and the underlying feature will have its geometry updated.
    static provided.mixedData.MixedDataKey<java.lang.Boolean> EDITABLE
    If true, the object can be edited by dragging control points and the underlying feature will have its geometry updated.
    static provided.mixedData.MixedDataKey<java.lang.String> FILL_COLOR
    The fill color.
    static provided.mixedData.MixedDataKey<java.lang.Double> FILL_OPACITY
    The fill opacity between 0.0 and 1.0.
    static provided.mixedData.MixedDataKey<java.lang.String> ICON
    Icon for the foreground.
    static java.util.UUID OPTIONS_ID
    Unique identifier for this class of options.
    static provided.mixedData.MixedDataKey<java.lang.String> STROKE_COLOR
    The stroke color.
    static provided.mixedData.MixedDataKey<java.lang.Double> STROKE_OPACITY
    The stroke opacity between 0.0 and 1.0.
    static provided.mixedData.MixedDataKey<java.lang.Integer> STROKE_WEIGHT
    The stroke width in pixels.
    static provided.mixedData.MixedDataKey<provided.mixedData.IMixedDataDictionary> STYLE
    Style for all features in the collection.
    static provided.mixedData.MixedDataKey<java.lang.String> TITLE
    Rollover text.
    static provided.mixedData.MixedDataKey<java.lang.Boolean> VISIBLE
    If true, the feature is visible.
    static provided.mixedData.MixedDataKey<java.lang.Double> ZINDEX
    All features are displayed on the map in order of their zIndex, with higher values displaying in front of features 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!

    • CLICKABLE

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

    • CURSOR

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

    • DRAGGABLE

      static final provided.mixedData.MixedDataKey<java.lang.Boolean> DRAGGABLE
      If true, the object can be dragged across the map and the underlying feature will have its geometry updated. Default value is false.

    • EDITABLE

      static final provided.mixedData.MixedDataKey<java.lang.Boolean> EDITABLE
      If true, the object can be edited by dragging control points and the underlying feature will have its geometry updated. Only applies to LineString and Polygon geometries. Default value is false.

    • FILL_COLOR

      static final provided.mixedData.MixedDataKey<java.lang.String> FILL_COLOR
      The fill color. All CSS3 colors are supported except for extended named colors. Only applies to polygon geometries.

    • FILL_OPACITY

      static final provided.mixedData.MixedDataKey<java.lang.Double> FILL_OPACITY
      The fill opacity between 0.0 and 1.0. Only applies to polygon geometries.

    • ICON

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

    • STROKE_COLOR

      static final provided.mixedData.MixedDataKey<java.lang.String> STROKE_COLOR
      The stroke color. All CSS3 colors are supported except for extended named colors. Only applies to line and polygon geometries.

    • STROKE_OPACITY

      static final provided.mixedData.MixedDataKey<java.lang.Double> STROKE_OPACITY
      The stroke opacity between 0.0 and 1.0. Only applies to line and polygon geometries.

    • STROKE_WEIGHT

      static final provided.mixedData.MixedDataKey<java.lang.Integer> STROKE_WEIGHT
      The stroke width in pixels. Only applies to line and polygon geometries.

    • TITLE

      static final provided.mixedData.MixedDataKey<java.lang.String> TITLE
      Rollover text. Only applies to line and polygon geometries.

    • VISIBLE

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

    • ZINDEX

      static final provided.mixedData.MixedDataKey<java.lang.Double> ZINDEX
      All features are displayed on the map in order of their zIndex, with higher values displaying in front of features with lower values. Markers are always displayed in front of line-strings and polygons.

    • STYLE

      static final provided.mixedData.MixedDataKey<provided.mixedData.IMixedDataDictionary> STYLE
      Style for all features in the collection. For more details, see the setStyle() method above.

  • 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 ICefUtils created by the system
      Returns:
      An IOptionsFiller for this component's options.