Package provided.owlMaps.components.shapes

Interface IPolygonOptions

All Superinterfaces:
IOptionsKeys, java.io.Serializable
public interface IPolygonOptions
extends IOptionsKeys
Options for creating polygons
Author:
swong

  • Field Summary

    Fields
    Modifier and Type Field Description
    static provided.mixedData.MixedDataKey<java.lang.Boolean> CLICKABLE
    Indicates whether this Polygon 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.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.Boolean> GEODESIC
    When true, edges of the polygon are interpreted as geodesic and will follow the curvature of the Earth.
    static java.util.UUID OPTIONS_ID
    Unique identifier for this class of options.
    static provided.mixedData.MixedDataKey<IPaths<ILatLng>> PATHS
    The ordered sequence of LatLng coordinates that designates a closed loop.
    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<StrokePosition> STROKE_POSITION
    The stroke position.
    static provided.mixedData.MixedDataKey<java.lang.Integer> STROKE_WEIGHT
    The stroke width in pixels.
    static provided.mixedData.MixedDataKey<java.lang.Boolean> VISIBLE
    Whether this polygon 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 Polygon 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.

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

    • FILL_OPACITY

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

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

    • PATHS

      static final provided.mixedData.MixedDataKey<IPaths<ILatLng>> PATHS
      The ordered sequence of LatLng coordinates that designates a closed loop. Unlike polylines, a polygon may consist of one or more paths. As a result, the paths property may specify one or more arrays of LatLng coordinates. Paths are closed automatically; do not repeat the first vertex of the path as the last vertex. Simple polygons may be defined using an IPath<ILatLng> (List of ILatLngs). More complex polygons may specify an IPathList<ILatLng> (A list of IPaths).

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

      static final provided.mixedData.MixedDataKey<StrokePosition> STROKE_POSITION
      The stroke position. Defaults to StrokePosition.CENTER. This property is not supported on Internet Explorer 8 and earlier.

    • 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 polygon is visible on the map. Defaults to true.

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