Package com.arubanetworks.meridian.maps

Class MapOptions

java.lang.Object
com.arubanetworks.meridian.maps.MapOptions
All Implemented Interfaces:
Serializable
public class MapOptions extends Object implements Serializable
A serializable options object for use with MapView and MapFragment.
See Also:

  • Field Details

    • HIDE_LEVELS_CONTROL

      public boolean HIDE_LEVELS_CONTROL
      If <code>true</code>, hide the level picker control.<p>The default is false.</p> <p>The level picker control takes users to other maps.</p>

    • HIDE_OVERVIEW_BUTTON

      public boolean HIDE_OVERVIEW_BUTTON
      If <code>true</code>, hide the overview button.<p>The default is false.</p> <p>The overview button allows users to navigate to the overview map, if one exists.</p>

    • HIDE_LOCATION_BUTTON

      public boolean HIDE_LOCATION_BUTTON
      If <code>true</code>, hide the location button.<p>The default is false.</p> <p>The location button shows the user&rsquo;s current location on the map. If their location is on a different map, the map view will switch to the map that contains the user&rsquo;s location.</p>

    • HIDE_MAP_LABEL

      public boolean HIDE_MAP_LABEL
      If <code>true</code>, hide the map label.<p>The default is false.</p> <p>The map label indicates the map name and building name of the current map.</p>

    • HIDE_LOADING_SPINNER

      public boolean HIDE_LOADING_SPINNER
      If <code>true</code>, hide the loading spinner.<p>The default is false.</p> <p>The loading spinner is a visual indication that content is loading.</p>

    • HIDE_ACCESSIBILITY_BUTTON

      public boolean HIDE_ACCESSIBILITY_BUTTON
      If <code>true</code>, hide the accessibility button when the map is displaying a route.<p>The default is false.</p> <p>The accessibility button allows the user to toggle a persistent preference to use either the shortest or the most accessible route. Toggling the preference will cause the map to reload the current route.</p>

    • HIDE_DIRECTIONS_CONTROLS

      public boolean HIDE_DIRECTIONS_CONTROLS
      If <code>true</code>, hide the directions control when a route is loaded.<p>The default is false.</p> <p>The directions control allows users to see information about a route and traverse its steps.</p>

    • HIDE_DIRECTIONS_CALLOUT

      public boolean HIDE_DIRECTIONS_CALLOUT
      If <code>true</code>, hide the directions callout when a route is loaded.<p>The default is false.</p> <p>The directions callout allows users to see the route overview and end directions. This value is only used if HIDE_DIRECTIONS_CONTROLS is false</p>

    • HIDE_SELECTED_MARKER_PIN

      public boolean HIDE_SELECTED_MARKER_PIN
      If <code>true</code>, hide the selected marker (pin).<p>The default is false.</p> <p>The selected marker (pin) is displayed when a placemark is selected.</p>

    • HIDE_BANNER_MESSAGE

      public boolean HIDE_BANNER_MESSAGE
      If <code>true</code>, always hide the banner message.<p>The default is false.</p> <p>The banner message is used to display information in a temporary message at the top of the map. (ex. &ldquo;Reorient yourself to the directions line&rdquo;)</p>

    • HIDE_WATERMARK

      @Deprecated public boolean HIDE_WATERMARK
      Deprecated.
      Deprecated: the watermark has been removed from the map.

    • USE_BOTTOMSHEET

      public boolean USE_BOTTOMSHEET
      If <code>true</code>, move the location button and map label to accomodate the bottom sheet.<p>The default is false.</p>

    • ACCENT_COLOR

      @ColorInt public int ACCENT_COLOR
      The color used to tint buttons on the map.

    • PLACEMARK_FONT_SIZE

      public int PLACEMARK_FONT_SIZE
      Size of a placemarks label in dp.

    • CALLOUT_PANEL_MAX_LINES

      public int CALLOUT_PANEL_MAX_LINES
      The number of lines of text used to display placemark detail information.<p>The default is 2.</p>

  • Constructor Details

    • MapOptions

      public MapOptions(MapOptions fromOptions)
      Initializes this MapOptions instance by copying the values of the given MapOptions instance.
      Parameters:
      fromOptions - The options to copy.

  • Method Details

    • getDefaultOptions

      public static MapOptions getDefaultOptions()
      A static factory method for getting a default options object.

    • getFromAttributes

      public static MapOptions getFromAttributes(Context context, AttributeSet attrs)
      A static factory method for getting a default options object with the provided attributes.

    • set

      public void set(MapOptions options)
      Sets this MapOptions values to that of another MapOptions.

    • fromAttributes

      public void fromAttributes(Context context, AttributeSet attrs)
      For use with the creation of MapViews from XML, simply pass the attributes and the MapOption will set itself up appropriately.

    • setTextSize

      public void setTextSize(int sizeInDP)
      Sets the placemark markers text size
      Parameters:
      sizeInDP - text size (in DP)

    • setCalloutPanelMaxLines

      public void setCalloutPanelMaxLines(int maxLines)
      Sets the max number of lines to show in the callout panel
      Parameters:
      maxLines - max number of lines