Package provided.owlMaps.general

Interface ISymbolOptions

All Superinterfaces:
IOptionsKeys, java.io.Serializable
public interface ISymbolOptions
extends IOptionsKeys
Options for a Google Maps Symbol object. There is no corresponding OwlMaps symbol class as the options dictionary is all that is needed to define a symbol..
Author:
swong

  • Field Summary

    Fields
    Modifier and Type Field Description
    static provided.mixedData.MixedDataKey<java.awt.geom.Point2D> ANCHOR
    The position of the symbol relative to the marker or polyline.
    static provided.mixedData.MixedDataKey<java.lang.String> FILL_COLOR
    The symbol's fill color.
    static provided.mixedData.MixedDataKey<java.lang.Double> FILL_OPACITY
    The symbol's fill opacity.
    static provided.mixedData.MixedDataKey<java.awt.geom.Point2D> LABEL_ORIGIN
    The origin of the label relative to the origin of the path, if label is supplied by the marker.
    static java.util.UUID OPTIONS_ID
    Unique identifier for this class of options.
    static provided.mixedData.MixedDataKey<ISymbolPath> PATH
    The symbol's path, which is a built-in symbol path, or a custom path expressed using SVG path notation.
    static provided.mixedData.MixedDataKey<java.lang.Double> ROTATION
    The angle by which to rotate the symbol, expressed clockwise in degrees.
    static provided.mixedData.MixedDataKey<java.lang.Double> SCALE
    The amount by which the symbol is scaled in size.
    static provided.mixedData.MixedDataKey<java.lang.String> STROKE_COLOR
    The symbol's stroke color.
    static provided.mixedData.MixedDataKey<java.lang.Double> STROKE_OPACITY
    The symbol's stroke opacity.
    static provided.mixedData.MixedDataKey<java.lang.Double> STROKE_WEIGHT
    The symbol's stroke weight.

  • 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

      static final provided.mixedData.MixedDataKey<java.awt.geom.Point2D> ANCHOR
      The position of the symbol relative to the marker or polyline. The coordinates of the symbol's path are translated left and up by the anchor's x and y coordinates respectively. By default, a symbol is anchored at (0, 0). The position is expressed in the same coordinate system as the symbol's path.

    • FILL_COLOR

      static final provided.mixedData.MixedDataKey<java.lang.String> FILL_COLOR
      The symbol's fill color. All CSS3 colors are supported except for extended named colors. For symbol markers, this defaults to 'black'. For symbols on polylines, this defaults to the stroke color of the corresponding polyline.

    • FILL_OPACITY

      static final provided.mixedData.MixedDataKey<java.lang.Double> FILL_OPACITY
      The symbol's fill opacity. Defaults to 0.

    • LABEL_ORIGIN

      static final provided.mixedData.MixedDataKey<java.awt.geom.Point2D> LABEL_ORIGIN
      The origin of the label relative to the origin of the path, if label is supplied by the marker. By default, the origin is located at (0, 0). The origin is expressed in the same coordinate system as the symbol's path. This property is unused for symbols on polylines.

    • PATH

      static final provided.mixedData.MixedDataKey<ISymbolPath> PATH
      The symbol's path, which is a built-in symbol path, or a custom path expressed using SVG path notation. Required.

    • ROTATION

      static final provided.mixedData.MixedDataKey<java.lang.Double> ROTATION
      The angle by which to rotate the symbol, expressed clockwise in degrees. Defaults to 0. A symbol in an IconSequence where fixedRotation is false is rotated relative to the angle of the edge on which it lies.

    • SCALE

      static final provided.mixedData.MixedDataKey<java.lang.Double> SCALE
      The amount by which the symbol is scaled in size. For symbol markers, this defaults to 1; after scaling, the symbol may be of any size. For symbols on a polyline, this defaults to the stroke weight of the polyline; after scaling, the symbol must lie inside a square 22 pixels in size centered at the symbol's anchor.

    • STROKE_COLOR

      static final provided.mixedData.MixedDataKey<java.lang.String> STROKE_COLOR
      The symbol's stroke color. All CSS3 colors are supported except for extended named colors. For symbol markers, this defaults to 'black'. For symbols on a polyline, this defaults to the stroke color of the polyline

    • STROKE_OPACITY

      static final provided.mixedData.MixedDataKey<java.lang.Double> STROKE_OPACITY
      The symbol's stroke opacity. For symbol markers, this defaults to 1. For symbols on a polyline, this defaults to the stroke opacity of the polyline.

    • STROKE_WEIGHT

      static final provided.mixedData.MixedDataKey<java.lang.Double> STROKE_WEIGHT
      The symbol's stroke weight. Defaults to the scale of the symbol.

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