org.fujion.gmaps

Class MapOptions

java.lang.Object

org.fujion.ancillary.Options

org.fujion.gmaps.MapOptions

All Implemented Interfaces:

org.fujion.ancillary.IOptionMapTransform, org.fujion.client.IClientTransform

public class MapOptions
extends org.fujion.ancillary.Options

Options for a Google Map.

Field Summary

Fields

Modifier and Type	Field and Description
String	backgroundColor Color used for the background of the Map div.
LatLng	center The initial Map center.
Boolean	clickableIcons When false, map icons are not clickable.
Boolean	disableDefaultUI Enables/disables all default UI.
Boolean	disableDoubleClickZoom Enables/disables zoom and center on double click.
String	draggableCursor The name or url of the cursor to display when mousing over a draggable map.
String	draggingCursor The name or url of the cursor to display when the map is being dragged.
Boolean	fullscreenControl The enabled/disabled state of the Fullscreen control.
FullscreenControlOptions	fullscreenControlOptions Options for Fullscreen control.
GestureHandlingType	gestureHandling Controls how the API handles gestures on the map.
Double	heading The heading for aerial imagery in degrees measured clockwise from cardinal direction North.
Boolean	keyboardShortcuts If false, prevents the map from being controlled by the keyboard.
Boolean	mapTypeControl The initial enabled/disabled state of the Map type control.
MapTypeControlOptions	mapTypeControlOptions Map type control options.
MapTypeId	mapTypeId$enum The initial Map mapTypeId as an enum.
String	mapTypeId$string The initial Map mapTypeId as a string.
Integer	maxZoom The maximum zoom level which will be displayed on the map.
Integer	minZoom The minimum zoom level which will be displayed on the map.
Boolean	noClear If true, do not clear the contents of the Map div.
Boolean	rotateControl The enabled/disabled state of the Rotate control.
RotateControlOptions	rotateControlOptions The display options for the Rotate control.
Boolean	scaleControl The initial enabled/disabled state of the Scale control.
ScaleControlOptions	scaleControlOptions The initial display options for the Scale control.
Boolean	scrollWheel If false, disables zooming on the map using a mouse scroll wheel.
Boolean	streetViewControl The initial enabled/disabled state of the Street View Pegman control.
StreetViewControlOptions	streetViewControlOptions The initial display options for the Street View Pegman control.
StreetViewPanoramaOptions	streetViewOptions Options to create a StreetViewPanorama to display when the Street View pegman is dropped on the map.
MapTypeStyleOptions	styles Styles to apply to each of the default map types.
TiltAngle	tilt Controls the automatic switching behavior for the angle of incidence of the map.
int	zoom The initial Map zoom level.
Boolean	zoomControl The enabled/disabled state of the Zoom control.
ZoomControlOptions	zoomControlOptions The display options for the Zoom control.

Constructor Summary

Constructors

Constructor and Description
MapOptions()

Method Summary

Methods inherited from class org.fujion.ancillary.Options

toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.fujion.ancillary.IOptionMapTransform

transformForClient

Field Detail

backgroundColor

@Option
public String backgroundColor

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

@Option
public LatLng center

The initial Map center. Required.

clickableIcons

@Option
public Boolean clickableIcons

When false, map icons are not clickable. A map icon represents a point of interest, also known as a POI.

Default: true

disableDefaultUI

@Option
public Boolean disableDefaultUI

Enables/disables all default UI. May be overridden individually.

disableDoubleClickZoom

@Option
public Boolean disableDoubleClickZoom

Enables/disables zoom and center on double click. Note: This property is not recommended. To disable zooming on double click, you can use the gestureHandling property, and set it to "none".

Default: false

draggableCursor

@Option
public String draggableCursor

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;'.

draggingCursor

@Option
public String draggingCursor

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;'.

fullscreenControl

@Option
public Boolean fullscreenControl

The enabled/disabled state of the Fullscreen control.

fullscreenControlOptions

@Option
public FullscreenControlOptions fullscreenControlOptions

Options for Fullscreen control.

gestureHandling

@Option
public GestureHandlingType gestureHandling

Controls how the API handles gestures on the map.

Default: AUTO

heading

@Option
public 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.

keyboardShortcuts

@Option
public Boolean keyboardShortcuts

If false, prevents the map from being controlled by the keyboard.

Default: true

mapTypeControl

@Option
public Boolean mapTypeControl

The initial enabled/disabled state of the Map type control.

mapTypeControlOptions

@Option
public final MapTypeControlOptions mapTypeControlOptions

Map type control options.

mapTypeId$enum

@Option(value="mapTypeId")
public MapTypeId mapTypeId$enum

The initial Map mapTypeId as an enum.

Default: ROADMAP

mapTypeId$string

@Option(value="mapTypeId")
public String mapTypeId$string

The initial Map mapTypeId as a string.

maxZoom

@Option
public Integer maxZoom

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.

minZoom

@Option
public Integer minZoom

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.

noClear

@Option
public Boolean noClear

If true, do not clear the contents of the Map div.

rotateControl

@Option
public Boolean rotateControl

The enabled/disabled state of the Rotate control.

rotateControlOptions

@Option
public final RotateControlOptions rotateControlOptions

The display options for the Rotate control.

scaleControl

@Option
public Boolean scaleControl

The initial enabled/disabled state of the Scale control.

scaleControlOptions

@Option
public final ScaleControlOptions scaleControlOptions

The initial display options for the Scale control.

scrollWheel

@Option
public Boolean scrollWheel

If false, disables zooming on the map using a mouse scroll wheel. Note: This property is not recommended. To disable zooming using scrollwheel, you can use the gestureHandling property, and set it to either "cooperative" or "none".

Default: true

streetViewOptions

@Option
public final StreetViewPanoramaOptions streetViewOptions

Options to create a StreetViewPanorama to display when the Street View pegman is dropped on the map. If no panorama is specified, a default StreetViewPanorama will be displayed in the map's div when the pegman is dropped.

streetViewControl

@Option
public Boolean streetViewControl

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

streetViewControlOptions

@Option
public final StreetViewControlOptions streetViewControlOptions

The initial display options for the Street View Pegman control.

styles

@Option
public final MapTypeStyleOptions styles

Styles to apply to each of the default map types. Note that for satellite/hybrid and terrain modes, these styles will only apply to labels and geometry.

tilt

@Option
public TiltAngle 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

@Option
public int zoom

The initial Map zoom level. Required. Valid values: Integers between zero, and up to the supported maximum zoom level.

Default: 8

zoomControl

@Option
public Boolean zoomControl

The enabled/disabled state of the Zoom control.

zoomControlOptions

@Option
public final ZoomControlOptions zoomControlOptions

The display options for the Zoom control.

Constructor Detail

MapOptions

public MapOptions()