Package provided.owlMaps.general

Interface IIconSequenceOptions

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

  • Field Summary

    Fields
    Modifier and Type Field Description
    static provided.mixedData.MixedDataKey<java.lang.Boolean> FIXED_ROTATION
    If true, each icon in the sequence has the same fixed rotation regardless of the angle of the edge on which it lies.
    static provided.mixedData.MixedDataKey<provided.mixedData.IMixedDataDictionary> ICON
    The icon to render on the line, as represented by an options dictionary of ISymbolOptions
    static provided.mixedData.MixedDataKey<java.lang.String> OFFSET
    The distance from the start of the line at which an icon is to be rendered.
    static java.util.UUID OPTIONS_ID
    Unique identifier for this class of options.
    static provided.mixedData.MixedDataKey<java.lang.String> REPEAT
    The distance between consecutive icons on the line.

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

    • FIXED_ROTATION

      static final provided.mixedData.MixedDataKey<java.lang.Boolean> FIXED_ROTATION
      If true, each icon in the sequence has the same fixed rotation regardless of the angle of the edge on which it lies. Defaults to false, in which case each icon in the sequence is rotated to align with its edge.

    • ICON

      static final provided.mixedData.MixedDataKey<provided.mixedData.IMixedDataDictionary> ICON
      The icon to render on the line, as represented by an options dictionary of ISymbolOptions

    • OFFSET

      static final provided.mixedData.MixedDataKey<java.lang.String> OFFSET
      The distance from the start of the line at which an icon is to be rendered. This distance may be expressed as a percentage of line's length (e.g. '50%') or in pixels (e.g. '50px'). Defaults to '100%'.

    • REPEAT

      static final provided.mixedData.MixedDataKey<java.lang.String> REPEAT
      The distance between consecutive icons on the line. This distance may be expressed as a percentage of the line's length (e.g. '50%') or in pixels (e.g. '50px'). To disable repeating of the icon, specify '0'. Defaults to '0'.

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