Package provided.owlMaps.components.marker

Interface IMarkerLabel

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
IMarkerLabelWrapped
public interface IMarkerLabel
extends java.io.Serializable
Represents a label for a marker
Author:
swong

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getColor()
    Get the color string of the label
    java.lang.String getFontFamily()
    Get the font family of the label
    java.lang.String getFontSize()
    Get the font size of the label text
    java.lang.String getFontWeight()
    Get the font weight of the label text
    provided.mixedData.IMixedDataDictionary getOptions()
    Return a dictionary of IMarkerLabelOption key-values corresponding to this label.
    java.lang.String getText()
    Get the label text
    static IMarkerLabel make​(java.lang.String colorStr, java.lang.String fontFamilyStr, java.lang.String fontSizeStr, java.lang.String fontWeightStr, java.lang.String textStr)
    Instantiate a new IMarkerLabel instance from the given parameters.
    static IMarkerLabel makeFromOptions​(provided.mixedData.IMixedDataDictionary options)
    Make a new instance of IMarkerLabel given a dictionary with IMarkerLabelOption key-values.
    static IMarkerLabel makeFromText​(java.lang.String text)
    Convenience factory method to instantiate a new IMarkerLabel using just a text string and default values for all other options
    void setColor​(java.lang.String colorStr)
    Set the color of the label text.
    void setFontFamily​(java.lang.String fontFamily)
    Set the font family of the label text (equivalent to the CSS font-family property).
    void setFontSize​(java.lang.String fontSize)
    Set the font size of the label text (equivalent to the CSS font-size property).
    void setFontWeight​(java.lang.String fontWeight)
    Set the font weight of the label text (equivalent to the CSS font-weight property).
    void setText​(java.lang.String text)
    SEt the text to be displayed in the label.

  • Method Details

    • getColor

      java.lang.String getColor()
      Get the color string of the label
      Returns:
      The color string

    • setColor

      void setColor​(java.lang.String colorStr)
      Set the color of the label text. Default color is black.
      Parameters:
      colorStr - The new color of the label

    • getFontFamily

      java.lang.String getFontFamily()
      Get the font family of the label
      Returns:
      The font family

    • setFontFamily

      void setFontFamily​(java.lang.String fontFamily)
      Set the font family of the label text (equivalent to the CSS font-family property).
      Parameters:
      fontFamily - The font family to use

    • getFontSize

      java.lang.String getFontSize()
      Get the font size of the label text
      Returns:
      The font size of the label

    • setFontSize

      void setFontSize​(java.lang.String fontSize)
      Set the font size of the label text (equivalent to the CSS font-size property). Default size is 14px.
      Parameters:
      fontSize - The new font size

    • getFontWeight

      java.lang.String getFontWeight()
      Get the font weight of the label text
      Returns:
      The font weight of the label

    • setFontWeight

      void setFontWeight​(java.lang.String fontWeight)
      Set the font weight of the label text (equivalent to the CSS font-weight property).
      Parameters:
      fontWeight - The font weight

    • getText

      java.lang.String getText()
      Get the label text
      Returns:
      The label text

    • setText

      void setText​(java.lang.String text)
      SEt the text to be displayed in the label.
      Parameters:
      text - The new text of the label

    • getOptions

      provided.mixedData.IMixedDataDictionary getOptions()
      Return a dictionary of IMarkerLabelOption key-values corresponding to this label. No key-value pair will be generated for any fields that are null.
      Returns:
      A dictionary of IMarkerLabelOption key-values

    • make

      static IMarkerLabel make​(java.lang.String colorStr, java.lang.String fontFamilyStr, java.lang.String fontSizeStr, java.lang.String fontWeightStr, java.lang.String textStr)
      Instantiate a new IMarkerLabel instance from the given parameters. null parameter values will use the default value for that parameter.
      Parameters:
      colorStr - The color of the label text. Default color is black.
      fontFamilyStr - The font family of the label text (equivalent to the CSS font-family property).
      fontSizeStr - The font size of the label text (equivalent to the CSS font-size property). Default size is 14px.
      fontWeightStr - The font weight of the label text (equivalent to the CSS font-weight property).
      textStr - The text to be displayed in the label.
      Returns:
      A new IMarkerLabel instance

    • makeFromText

      static IMarkerLabel makeFromText​(java.lang.String text)
      Convenience factory method to instantiate a new IMarkerLabel using just a text string and default values for all other options
      Parameters:
      text - The text of the label
      Returns:
      A new IMarkerLabel instance

    • makeFromOptions

      static IMarkerLabel makeFromOptions​(provided.mixedData.IMixedDataDictionary options)
      Make a new instance of IMarkerLabel given a dictionary with IMarkerLabelOption key-values. Default values will be used for missing keys.
      Parameters:
      options - A dictionary holding IMarkerLabelOption key-values.
      Returns:
      A new IMarkerLabel instance