Package provided.owlMaps.general

Interface ISymbol

All Superinterfaces:
java.io.Serializable
public interface ISymbol
extends java.io.Serializable
Represents a google.maps.Symbol object 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 Currently only built-in symbol shapes (google.maps.SymbolPath constants) are supported. Custom SVG paths are not supported yet.
Author:
swong

  • Method Summary

    Modifier and Type Method Description
    java.awt.geom.Point2D getAnchor()
    Get the position of the symbol relative to the marker or polyline in pixels as a 2D point
    java.lang.String getFillColor()
    Get the symbol's fill color
    double getFillOpacity()
    Get the symbol's fill opacity
    java.awt.geom.Point2D getLabelOrigin()
    For symbols on markers only: Get the origin of the label relative to the origin of the path.
    provided.mixedData.IMixedDataDictionary getOptions()
    Get the options dictionary that would produce the equivalent ISymbol object.
    ISymbolPath getPath()
    Get the ISymbolPath enum corresponding to the displayed shape of the symbol
    double getRotation()
    Get the clockwise rotation of the symbol in degrees.
    double getScale()
    Get the amount (multiplicative factor) the symbol is scaled when displayed.
    java.lang.String getStrokeColor()
    Get the symbol's stroke color
    double getStrokeOpacity()
    Get the symbol's stroke opacity
    double getStrokeWeight()
    The symbol's stroke weight
    static ISymbol make​(provided.mixedData.IMixedDataDictionary options)
    Factory method to instantiate an ISymbol 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

    • getPath

      ISymbolPath getPath()
      Get the ISymbolPath enum corresponding to the displayed shape of the symbol
      Returns:
      The shape of the symbol

    • getAnchor

      java.awt.geom.Point2D getAnchor()
      Get the position of the symbol relative to the marker or polyline in pixels as a 2D point
      Returns:
      The relative symbol position

    • getFillColor

      java.lang.String getFillColor()
      Get the symbol's fill color
      Returns:
      A color string

    • getFillOpacity

      double getFillOpacity()
      Get the symbol's fill opacity
      Returns:
      the fill opacity

    • getLabelOrigin

      java.awt.geom.Point2D getLabelOrigin()
      For symbols on markers only: Get the origin of the label relative to the origin of the path. The value is undefined for symbols on polylines.
      Returns:
      The label origin position

    • getRotation

      double getRotation()
      Get the clockwise rotation of the symbol in degrees. For symbols in IIconSequences, the angle is relative to the edge the symbol is on.
      Returns:
      the rotation angle

    • getScale

      double getScale()
      Get the amount (multiplicative factor) the symbol is scaled when displayed.
      Returns:
      The scale factor.

    • getStrokeColor

      java.lang.String getStrokeColor()
      Get the symbol's stroke color
      Returns:
      a color string

    • getStrokeOpacity

      double getStrokeOpacity()
      Get the symbol's stroke opacity
      Returns:
      The stroke opacity

    • getStrokeWeight

      double getStrokeWeight()
      The symbol's stroke weight
      Returns:
      The stroke weight.

    • getOptions

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

    • make

      static ISymbol make​(provided.mixedData.IMixedDataDictionary options)
      Factory method to instantiate an ISymbol from an options dictionary
      Parameters:
      options - An options dictionary contating ISymbolOptions
      Returns:
      A new ISymbol 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