Package provided.owlMaps.general

Interface IIconSequence

All Superinterfaces:
java.io.Serializable
public interface IIconSequence
extends java.io.Serializable
Represents a google.maps.IconSequence object which is a sequence of identical icons on a line (could be polyline). Instances of this entity are generally not used on the Java side. Specifications for this object in options dictionaries are implemented as the options dictionary needed to instantiate the object on the JavaScript side
Author:
swong

  • Method Summary

    Modifier and Type Method Description
    boolean getFixedRotation()
    Get the setting for whether or not the icons have a fixed rotation
    ISymbol getIcon()
    Get the icon that is being displayed
    java.lang.String getOffset()
    Get the distance from the start of the line at which the icon is to be rendered.
    provided.mixedData.IMixedDataDictionary getOptions()
    Get the options dictionary that would produce the equivalent IIconSequence object.
    java.lang.String getRepeat()
    Get the distance between consecutive icons on the line.
    static IIconSequence make​(provided.mixedData.IMixedDataDictionary options)
    Factory method to instantiate an IIconSequence object from an options dictionary.
    static com.google.gson.TypeAdapterFactory makeTypeAdapterFactory()
    *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER DIRECTLY USE THIS METHOD! ***
    Instantiate a GSON TypeAdapterFactory for the class

  • Method Details

    • getFixedRotation

      boolean getFixedRotation()
      Get the setting for whether or not the icons have a fixed rotation
      Returns:
      True if each icon in the sequence has the same fixed rotation regardless of the angle of the edge on which it lies, false if each icon in the sequence is rotated to align with its edge.

    • getIcon

      ISymbol getIcon()
      Get the icon that is being displayed
      Returns:
      The icon as an ISymbol

    • getOffset

      java.lang.String getOffset()
      Get the distance from the start of the line at which the icon is to be rendered. The String value could be in a percentage format, e.g. "XX%" of the line's length or in pixels, e.g. "YYpx".
      Returns:
      The icon offset setting.

    • getRepeat

      java.lang.String getRepeat()
      Get the distance between consecutive icons on the line. The String value could be in a percentage format, e.g. "XX%" of the line's length or in pixels, e.g. "YYpx". A value of "0" means no repeated icons are displayed.
      Returns:
      The icon repeat setting

    • getOptions

      provided.mixedData.IMixedDataDictionary getOptions()
      Get the options dictionary that would produce the equivalent IIconSequence object.
      Returns:
      An options dictionary corresponding to this IIconSequence object.

    • make

      static IIconSequence make​(provided.mixedData.IMixedDataDictionary options)
      Factory method to instantiate an IIconSequence object from an options dictionary.
      Parameters:
      options - The options dictionary to configure the IIconSequence instance
      Returns:
      A new IIconSequence instance

    • makeTypeAdapterFactory

      static com.google.gson.TypeAdapterFactory makeTypeAdapterFactory()
      *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER DIRECTLY USE THIS METHOD! ***
      Instantiate a GSON TypeAdapterFactory for the class
      Returns:
      A TypeAdapterFactory to process the class type