Package provided.owlMaps.map

Interface IMapOptions

All Superinterfaces:
IOptionsKeys, java.io.Serializable
public interface IMapOptions
extends IOptionsKeys
Available options for configuring a map
Author:
swong

  • Field Summary

    Fields
    Modifier and Type Field Description
    static provided.mixedData.MixedDataKey<java.lang.String> BACKGROUND_COLOR
    Color used for the background of the Map div.
    static provided.mixedData.MixedDataKey<ILatLng> CENTER
    The initial Map center.
    static provided.mixedData.MixedDataKey<java.lang.Boolean> CLICKABLE_ICONS
    When false, map icons are not clickable.
    static provided.mixedData.MixedDataKey<java.lang.Double> CONTROL_SIZE
    Size in pixels of the controls appearing on the map.
    static provided.mixedData.MixedDataKey<java.lang.Boolean> DISABLE_DEFAULT_UI
    Enables/disables all default UI.
    static provided.mixedData.MixedDataKey<java.lang.String> DRAGGABLE_CURSOR
    The name or url of the cursor to display when mousing over a draggable map.
    static provided.mixedData.MixedDataKey<java.lang.String> DRAGGING_CURSOR
    The name or url of the cursor to display when the map is being dragged.
    static provided.mixedData.MixedDataKey<java.lang.Boolean> FULL_SCREEN_CONTROL
    The enabled/disabled state of the Fullscreen control.
    static provided.mixedData.MixedDataKey<java.lang.String> GESTURE_HANDLING
    This setting controls how the API handles gestures on the map.
    static provided.mixedData.MixedDataKey<java.lang.Double> HEADING
    The heading for aerial imagery in degrees measured clockwise from cardinal direction North.
    static provided.mixedData.MixedDataKey<java.lang.Boolean> KEYBOARD_SHORTCUTS
    If false, prevents the map from being controlled by the keyboard.
    static provided.mixedData.MixedDataKey<java.lang.Boolean> MAP_TYPE_CONTROL
    The initial enabled/disabled state of the Map type control
    static provided.mixedData.MixedDataKey<MapTypeId> MAP_TYPE_ID
    The initial Map mapTypeId.
    static provided.mixedData.MixedDataKey<java.lang.Integer> MAX_ZOOM
    The maximum zoom level which will be displayed on the map.
    static provided.mixedData.MixedDataKey<java.lang.Integer> MIN_ZOOM
    The minimum zoom level which will be displayed on the map.
    static java.util.UUID OPTIONS_ID
    Unique identifier for this class of options.
    static provided.mixedData.MixedDataKey<java.lang.Boolean> ROTATE_CONTROL
    The enabled/disabled state of the Rotate control.
    static provided.mixedData.MixedDataKey<java.lang.Boolean> SCALE_CONTROL
    The initial enabled/disabled state of the Scale control.
    static provided.mixedData.MixedDataKey<java.lang.Boolean> STREET_VIEW_CONTROL
    The initial enabled/disabled state of the Street View Pegman control.
    static provided.mixedData.MixedDataKey<java.lang.Double> TILT
    Controls the automatic switching behavior for the angle of incidence of the map.
    static provided.mixedData.MixedDataKey<java.lang.Integer> ZOOM
    The initial Map zoom level.
    static provided.mixedData.MixedDataKey<java.lang.Boolean> ZOOM_CONTROL
    The enabled/disabled state of the Zoom control.

  • Method Summary

    Static Methods
    Modifier and Type Method Description
    static provided.mixedData.IMixedDataDictionary makeDefault()
    Make a dictionary of the default options for the map.
    static IOptionsFiller makeOptionsFiller​(ICefUtils cefUtils)
    *FOR INTERNAL USE ONLY!!* OWLMAPS DEVELOPER CODE SHOULD *NOT* USE THIS METHOD! Factory to create the IOptionsFiller that converts the component options into their corresponding Javascript Google Map component options.

  • Field Details

    • OPTIONS_ID

      static final java.util.UUID OPTIONS_ID
      Unique identifier for this class of options. Always refer to this field by name and not by its value to ensure compatibility when the codebase is updated as the value of the field may change!

    • BACKGROUND_COLOR

      static final provided.mixedData.MixedDataKey<java.lang.String> BACKGROUND_COLOR
      Color used for the background of the Map div. This color will be visible when tiles have not yet loaded as the user pans. This option can only be set when the map is initialized.

    • CENTER

      static final provided.mixedData.MixedDataKey<ILatLng> CENTER
      The initial Map center. Required.

    • CLICKABLE_ICONS

      static final provided.mixedData.MixedDataKey<java.lang.Boolean> CLICKABLE_ICONS
      When false, map icons are not clickable. A map icon represents a point of interest, also known as a POI. By default map icons are clickable.

    • CONTROL_SIZE

      static final provided.mixedData.MixedDataKey<java.lang.Double> CONTROL_SIZE
      Size in pixels of the controls appearing on the map. This value must be supplied directly when creating the Map, updating this value later may bring the controls into an undefined state. Only governs the controls made by the Maps API itself. Does not scale developer created custom controls.

    • DISABLE_DEFAULT_UI

      static final provided.mixedData.MixedDataKey<java.lang.Boolean> DISABLE_DEFAULT_UI
      Enables/disables all default UI. May be overridden individually.

    • DRAGGABLE_CURSOR

      static final provided.mixedData.MixedDataKey<java.lang.String> DRAGGABLE_CURSOR
      The name or url of the cursor to display when mousing over a draggable map. This property uses the css cursor attribute to change the icon. As with the css property, you must specify at least one fallback cursor that is not a URL. For example: draggableCursor: 'url(http://www.example.com/icon.png), auto;'.

    • DRAGGING_CURSOR

      static final provided.mixedData.MixedDataKey<java.lang.String> DRAGGING_CURSOR
      The name or url of the cursor to display when the map is being dragged. This property uses the css cursor attribute to change the icon. As with the css property, you must specify at least one fallback cursor that is not a URL. For example: draggingCursor: 'url(http://www.example.com/icon.png), auto;'.

    • FULL_SCREEN_CONTROL

      static final provided.mixedData.MixedDataKey<java.lang.Boolean> FULL_SCREEN_CONTROL
      The enabled/disabled state of the Fullscreen control.

    • GESTURE_HANDLING

      static final provided.mixedData.MixedDataKey<java.lang.String> GESTURE_HANDLING
      This setting controls how the API handles gestures on the map. Allowed values:
      • "cooperative": Scroll events and one-finger touch gestures scroll the page, and do not zoom or pan the map. Two-finger touch gestures pan and zoom the map. Scroll events with a ctrl key or ⌘ key pressed zoom the map. In this mode the map cooperates with the page.
      • "greedy": All touch gestures and scroll events pan or zoom the map.
      • "none": The map cannot be panned or zoomed by user gestures.
      • "auto": (default) Gesture handling is either cooperative or greedy, depending on whether the page is scrollable or in an iframe.

    • HEADING

      static final provided.mixedData.MixedDataKey<java.lang.Double> HEADING
      The heading for aerial imagery in degrees measured clockwise from cardinal direction North. Headings are snapped to the nearest available angle for which imagery is available.

    • KEYBOARD_SHORTCUTS

      static final provided.mixedData.MixedDataKey<java.lang.Boolean> KEYBOARD_SHORTCUTS
      If false, prevents the map from being controlled by the keyboard. Keyboard shortcuts are enabled by default.

    • MAP_TYPE_CONTROL

      static final provided.mixedData.MixedDataKey<java.lang.Boolean> MAP_TYPE_CONTROL
      The initial enabled/disabled state of the Map type control

    • MAP_TYPE_ID

      static final provided.mixedData.MixedDataKey<MapTypeId> MAP_TYPE_ID
      The initial Map mapTypeId. Defaults to "roadmap". Options are "hybrid", "roadmap", "satellite" and "terrain".

    • MAX_ZOOM

      static final provided.mixedData.MixedDataKey<java.lang.Integer> MAX_ZOOM
      The maximum zoom level which will be displayed on the map. If omitted, or set to null, the maximum zoom from the current map type is used instead. Valid values: Integers between zero, and up to the supported maximum zoom level.

    • MIN_ZOOM

      static final provided.mixedData.MixedDataKey<java.lang.Integer> MIN_ZOOM
      The minimum zoom level which will be displayed on the map. If omitted, or set to null, the minimum zoom from the current map type is used instead. Valid values: Integers between zero, and up to the supported maximum zoom level.

    • ROTATE_CONTROL

      static final provided.mixedData.MixedDataKey<java.lang.Boolean> ROTATE_CONTROL
      The enabled/disabled state of the Rotate control.

    • SCALE_CONTROL

      static final provided.mixedData.MixedDataKey<java.lang.Boolean> SCALE_CONTROL
      The initial enabled/disabled state of the Scale control.

    • STREET_VIEW_CONTROL

      static final provided.mixedData.MixedDataKey<java.lang.Boolean> STREET_VIEW_CONTROL
      The initial enabled/disabled state of the Street View Pegman control. This control is part of the default UI, and should be set to false when displaying a map type on which the Street View road overlay should not appear (e.g. a non-Earth map type).

    • TILT

      static final provided.mixedData.MixedDataKey<java.lang.Double> TILT
      Controls the automatic switching behavior for the angle of incidence of the map. The only allowed values are 0 and 45. The value 0 causes the map to always use a 0° overhead view regardless of the zoom level and viewport. The value 45 causes the tilt angle to automatically switch to 45 whenever 45° imagery is available for the current zoom level and viewport, and switch back to 0 whenever 45° imagery is not available (this is the default behavior). 45° imagery is only available for satellite and hybrid map types, within some locations, and at some zoom levels. Note: getTilt returns the current tilt angle, not the value specified by this option. Because getTilt and this option refer to different things, do not bind() the tilt property; doing so may yield unpredictable effects.

    • ZOOM

      static final provided.mixedData.MixedDataKey<java.lang.Integer> ZOOM
      The initial Map zoom level. Required. Valid values: Integers between zero, and up to the supported maximum zoom level.

    • ZOOM_CONTROL

      static final provided.mixedData.MixedDataKey<java.lang.Boolean> ZOOM_CONTROL
      The enabled/disabled state of the Zoom control.

  • Method Details

    • makeDefault

      static provided.mixedData.IMixedDataDictionary makeDefault()
      Make a dictionary of the default options for the map.
      Returns:
      A dictionary with any default options

    • makeOptionsFiller

      static IOptionsFiller makeOptionsFiller​(ICefUtils cefUtils)
      *FOR INTERNAL USE ONLY!!* OWLMAPS DEVELOPER CODE SHOULD *NOT* USE THIS METHOD! Factory to create the IOptionsFiller that converts the component options into their corresponding Javascript Google Map component options.
      Parameters:
      cefUtils - The ICefUtils created by the system
      Returns:
      An IOptionsFiller for this component's options.