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 true, hide the level picker control.

      The default is false.

      The level picker control takes users to other maps.

    • HIDE_OVERVIEW_BUTTON

      public boolean HIDE_OVERVIEW_BUTTON
      If true, hide the overview button.

      The default is false.

      The overview button allows users to navigate to the overview map, if one exists.

    • HIDE_LOCATION_BUTTON

      public boolean HIDE_LOCATION_BUTTON
      If true, hide the location button.

      The default is false.

      The location button shows the user’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’s location.

    • HIDE_MAP_LABEL

      public boolean HIDE_MAP_LABEL
      If true, hide the map label.

      The default is false.

      The map label indicates the map name and building name of the current map.

    • HIDE_LOADING_SPINNER

      public boolean HIDE_LOADING_SPINNER
      If true, hide the loading spinner.

      The default is false.

      The loading spinner is a visual indication that content is loading.

    • HIDE_ACCESSIBILITY_BUTTON

      public boolean HIDE_ACCESSIBILITY_BUTTON
      If true, hide the accessibility button when the map is displaying a route.

      The default is false.

      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.

    • HIDE_DIRECTIONS_CONTROLS

      public boolean HIDE_DIRECTIONS_CONTROLS
      If true, hide the directions control when a route is loaded.

      The default is false.

      The directions control allows users to see information about a route and traverse its steps.

    • HIDE_SELECTED_MARKER_PIN

      public boolean HIDE_SELECTED_MARKER_PIN
      If true, hide the selected marker (pin).

      The default is false.

      The selected marker (pin) is displayed when a placemark is selected.

    • HIDE_BANNER_MESSAGE

      public boolean HIDE_BANNER_MESSAGE
      If true, always hide the banner message.

      The default is false.

      The banner message is used to display information in a temporary message at the top of the map. (ex. “Reorient yourself to the directions line”)

    • HIDE_WATERMARK

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

    • USE_BOTTOMSHEET

      public boolean USE_BOTTOMSHEET
      If true, move the location button and map label to accomodate the bottom sheet.

      The default is false.

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

      The default is 2.

  • 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