Package provided.owlMaps.components.shapes

Interface IPolylineOptions

All Superinterfaces:
IOptionsKeys, java.io.Serializable
public interface IPolylineOptions
extends IOptionsKeys
The options for a IPolyLine
Author:
swong

  • Field Summary

    Fields
    Modifier and Type Field Description
    static provided.mixedData.MixedDataKey<java.lang.Boolean> CLICKABLE
    Indicates whether this Polyline handles mouse events.
    static provided.mixedData.MixedDataKey<java.lang.Boolean> DRAGGABLE
    If set to true, the user can drag this shape over the map.
    static provided.mixedData.MixedDataKey<java.lang.Boolean> EDITABLE
    If set to true, the user can edit this shape by dragging the control points shown at the vertices and on each segment.
    static provided.mixedData.MixedDataKey<java.lang.Boolean> GEODESIC
    When true, edges of the polygon are interpreted as geodesic and will follow the curvature of the Earth.
    static provided.mixedData.MixedDataKey<java.util.List<provided.mixedData.IMixedDataDictionary>> ICONS
    The icons to be rendered along the polyline as represented by a List of options dictionaries of IIconSequenceOptions
    static java.util.UUID OPTIONS_ID
    Unique identifier for this class of options.
    static provided.mixedData.MixedDataKey<IPath<ILatLng>> PATH
    The ordered sequence (IPath) of ILatLng coordinates of the Polyline.
    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<java.lang.Boolean> VISIBLE
    Whether this polyline is visible on the map.
    static provided.mixedData.MixedDataKey<java.lang.Double> ZINDEX
    The zIndex compared to other polys.

  • 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!! DEVELOPER CODE SHOULD NEVER 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
      Indicates whether this Polyline handles mouse events. Defaults to true.

    • DRAGGABLE

      static final provided.mixedData.MixedDataKey<java.lang.Boolean> DRAGGABLE
      If set to true, the user can drag this shape over the map. The geodesic property defines the mode of dragging. Defaults to false.

    • EDITABLE

      static final provided.mixedData.MixedDataKey<java.lang.Boolean> EDITABLE
      If set to true, the user can edit this shape by dragging the control points shown at the vertices and on each segment. Defaults to false.

    • GEODESIC

      static final provided.mixedData.MixedDataKey<java.lang.Boolean> GEODESIC
      When true, edges of the polygon are interpreted as geodesic and will follow the curvature of the Earth. When false, edges of the polygon are rendered as straight lines in screen space. Note that the shape of a geodesic polygon may appear to change when dragged, as the dimensions are maintained relative to the surface of the earth. Defaults to false.

    • ICONS

      static final provided.mixedData.MixedDataKey<java.util.List<provided.mixedData.IMixedDataDictionary>> ICONS
      The icons to be rendered along the polyline as represented by a List of options dictionaries of IIconSequenceOptions

    • PATH

      static final provided.mixedData.MixedDataKey<IPath<ILatLng>> PATH
      The ordered sequence (IPath) of ILatLng coordinates of the Polyline.

    • 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.

    • STROKE_OPACITY

      static final provided.mixedData.MixedDataKey<java.lang.Double> STROKE_OPACITY
      The stroke opacity between 0.0 and 1.0.

    • STROKE_WEIGHT

      static final provided.mixedData.MixedDataKey<java.lang.Integer> STROKE_WEIGHT
      The stroke width in pixels.

    • VISIBLE

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

    • ZINDEX

      static final provided.mixedData.MixedDataKey<java.lang.Double> ZINDEX
      The zIndex compared to other polys.

  • 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!! DEVELOPER CODE SHOULD NEVER 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.