com.teamdev.jxmaps

Class MapOptions

java.lang.Object

com.teamdev.jxmaps.MapObject

com.teamdev.jxmaps.MapOptions

All Implemented Interfaces:

java.lang.Cloneable

public class MapOptions
extends MapObject

Represents map object options.

Constructor Summary

Constructors

Constructor and Description
MapOptions() Creates new MapOptions object.
MapOptions(Map map) Deprecated.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBackgroundColor() Returns value of backgroundColor property.
LatLng	getCenter() Returns value of center property.
boolean	getClickableIcons() Returns value of disableDoubleClickZoom property.
boolean	getDisableDefaultUI() Returns value of disableDefaultUI property.
boolean	getDisableDoubleClickZoom() Returns value of disableDoubleClickZoom property.
boolean	getDraggable() Returns value of draggable property.
java.lang.String	getDraggableCursor() Returns value of draggableCursor property.
boolean	getDraggingCursor() Returns value of draggingCursor property.
double	getHeading() Returns value of heading property.
boolean	getKeyboardShortcuts() Returns value of keyboardShortcuts property.
boolean	getMapMaker() Returns value of mapMaker property.
boolean	getMapTypeControl() Returns value of mapTypeControl property.
MapTypeControlOptions	getMapTypeControlOptions() Returns value of mapTypeControlOptions property.
MapTypeId	getMapTypeId() Returns value of mapTypeId property.
double	getMaxZoom() Returns value of maxZoom property.
double	getMinZoom() Returns value of minZoom property.
boolean	getNoClear() Returns value of noClear property.
boolean	getOverviewMapControl() Returns value of overviewMapControl property.
OverviewMapControlOptions	getOverviewMapControlOptions() Returns value of overviewMapControlOptions property.
boolean	getPanControl() Returns value of panControl property.
PanControlOptions	getPanControlOptions() Returns value of panControlOptions property.
boolean	getRotateControl() Returns value of rotateControl property.
RotateControlOptions	getRotateControlOptions() Returns value of rotateControlOptions property.
boolean	getScaleControl() Returns value of scaleControl property.
ScaleControlOptions	getScaleControlOptions() Returns value of scaleControlOptions property.
boolean	getScrollWheel() Returns value of scrollWheel property.
StreetViewPanorama	getStreetView() Returns value of streetView property.
boolean	getStreetViewControl() Returns value of streetViewControl property.
StreetViewControlOptions	getStreetViewControlOptions() Returns value of streetViewControlOptions property.
MapTypeStyle[]	getStyles() Returns value of styles property.
double	getTilt() Returns value of tilt property.
double	getZoom() Returns value of zoom property.
boolean	getZoomControl() Returns value of zoomControl property.
ZoomControlOptions	getZoomControlOptions() Returns value of zoomControlOptions property.
void	setBackgroundColor(java.lang.String color) Sets new value for backgroundColor property.
void	setCenter(LatLng center) Sets new value for center property.
void	setClickableIcons(boolean value) Sets new value for disableDefaultUI property.
void	setDisableDefaultUI(boolean disable) Sets new value for disableDefaultUI property.
void	setDisableDoubleClickZoom(boolean disable) Sets new value for disableDoubleClickZoom property.
void	setDraggable(boolean draggable) Sets new value for draggable property.
void	setDraggableCursor(java.lang.String cursor) Sets new value for draggableCursor property.
void	setDraggingCursor(boolean value) Sets new value for draggingCursor property.
void	setHeading(double heading) Sets new value for heading property.
void	setKeyboardShortcuts(boolean enable) Sets new value for keyboardShortcuts property.
void	setMapMaker(boolean mapMaker) Sets new value for mapMaker property.
void	setMapTypeControl(boolean value) Sets new value for mapTypeControl property.
void	setMapTypeControlOptions(MapTypeControlOptions options) Sets new value for mapTypeControlOptions property.
void	setMapTypeId(MapTypeId typeId) Sets new value for mapTypeId property.
void	setMaxZoom(double zoom) Sets new value for maxZoom property.
void	setMinZoom(double zoom) Sets new value for minZoom property.
void	setNoClear(boolean noClear) Sets new value for noClear property.
void	setOverviewMapControl(boolean value) Sets new value for overviewMapControl property.
void	setOverviewMapControlOptions(OverviewMapControlOptions options) Sets new value for overviewMapControlOptions property.
void	setPanControl(boolean value) Sets new value for panControl property.
void	setPanControlOptions(PanControlOptions options) Sets new value for panControlOptions property.
void	setRotateControl(boolean value) Sets new value for rotateControl property.
void	setRotateControlOptions(RotateControlOptions options) Sets new value for rotateControlOptions property.
void	setScaleControl(boolean value) Sets new value for scaleControl property.
void	setScaleControlOptions(ScaleControlOptions options) Sets new value for scaleControlOptions property.
void	setScrollWheel(boolean value) Sets new value for scrollwheel property.
void	setStreetView(StreetViewPanorama streetView) Sets new value for streetView property.
void	setStreetViewControl(boolean value) Sets new value for streetViewControl property.
void	setStreetViewControlOptions(StreetViewControlOptions options) Sets new value for streetViewControlOptions property.
void	setStyles(MapTypeStyle[] styles) Sets new value for styles property.
void	setTilt(double tilt) Sets new value for tilt property.
void	setZoom(double value) Sets new value for zoom property.
void	setZoomControl(boolean value) Sets new value for zoomControl property.
void	setZoomControlOptions(ZoomControlOptions options) Sets new value for zoomControlOptions property.

Methods inherited from class com.teamdev.jxmaps.MapObject

addEventListener, attachObject, cacheProperties, cacheProperties, clone, createJSValue, dispose, fromJSValue, getJSObject, getMap, getProperties, invokeMethod, propertyChanged, removeEventListener, updateProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

MapOptions

public MapOptions()

Creates new MapOptions object.

MapOptions

@Deprecated
public MapOptions(Map map)

Deprecated.

Creates new MapOptions object.

Parameters:

map - owner Map object

Method Detail

getBackgroundColor

public java.lang.String getBackgroundColor()

Returns value of backgroundColor property.

Represents color used for the background of the Map. 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.

Returns:

property value

See Also:

setBackgroundColor(java.lang.String)

setBackgroundColor

public void setBackgroundColor(java.lang.String color)

Sets new value for backgroundColor property.

Parameters:

color - new property value

See Also:

getBackgroundColor()

getCenter

public LatLng getCenter()

Returns value of center property.

Represents the initial Map center. Required.

Returns:

property value

See Also:

setCenter(com.teamdev.jxmaps.LatLng)

setCenter

public void setCenter(LatLng center)

Sets new value for center property.

Parameters:

center - new property value

See Also:

getCenter()

getDisableDefaultUI

public boolean getDisableDefaultUI()

Returns value of disableDefaultUI property.

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

Returns:

property value

See Also:

setDisableDefaultUI(boolean)

setDisableDefaultUI

public void setDisableDefaultUI(boolean disable)

Sets new value for disableDefaultUI property.

Parameters:

disable - new property value

See Also:

getDisableDefaultUI()

getDisableDoubleClickZoom

public boolean getDisableDoubleClickZoom()

Returns value of disableDoubleClickZoom property.

Enables/disables zoom and center on double click. Enabled by default.

Returns:

property value

See Also:

setDisableDoubleClickZoom(boolean)

setClickableIcons

public void setClickableIcons(boolean value)

Sets new value for disableDefaultUI property.

Parameters:

value - new property value

See Also:

getClickableIcons()

getClickableIcons

public boolean getClickableIcons()

Returns value of disableDoubleClickZoom property. A map icon represents a point of interest, also known as a POI. If the returned value is true, then the icons are clickable on the map.

Returns:

property value

See Also:

setClickableIcons(boolean)

setDisableDoubleClickZoom

public void setDisableDoubleClickZoom(boolean disable)

Sets new value for disableDoubleClickZoom property.

Parameters:

disable - new property value

See Also:

getDisableDoubleClickZoom()

getDraggable

public boolean getDraggable()

Returns value of draggable property.

If false, prevents the map from being dragged. Dragging is enabled by default.

Returns:

property value

See Also:

setDraggable(boolean)

setDraggable

public void setDraggable(boolean draggable)

Sets new value for draggable property.

Parameters:

draggable - new property value

See Also:

getDraggable()

getDraggableCursor

public java.lang.String getDraggableCursor()

Returns value of draggableCursor property.

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

Returns:

property value

See Also:

setDraggableCursor(java.lang.String)

setDraggableCursor

public void setDraggableCursor(java.lang.String cursor)

Sets new value for draggableCursor property.

Parameters:

cursor - new property value

See Also:

getDraggableCursor()

getDraggingCursor

public boolean getDraggingCursor()

Returns value of draggingCursor property.

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

Returns:

property value

See Also:

setDraggingCursor(boolean)

setDraggingCursor

public void setDraggingCursor(boolean value)

Sets new value for draggingCursor property.

Parameters:

value - new property value

See Also:

getDraggingCursor()

getHeading

public double getHeading()

Returns value of heading property.

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

Returns:

property value

See Also:

setHeading(double)

setHeading

public void setHeading(double heading)

Sets new value for heading property.

Parameters:

heading - new property value

See Also:

getHeading()

getKeyboardShortcuts

public boolean getKeyboardShortcuts()

Returns value of keyboardShortcuts property.

If false, prevents the map from being controlled by the keyboard. Keyboard shortcuts are enabled by default.

Returns:

property value

See Also:

setKeyboardShortcuts(boolean)

setKeyboardShortcuts

public void setKeyboardShortcuts(boolean enable)

Sets new value for keyboardShortcuts property.

Parameters:

enable - new property value

See Also:

getKeyboardShortcuts()

getMapMaker

public boolean getMapMaker()

Returns value of mapMaker property.

True if Map Maker tiles should be used instead of regular tiles.

Returns:

property value

See Also:

setMapMaker(boolean)

setMapMaker

public void setMapMaker(boolean mapMaker)

Sets new value for mapMaker property.

Parameters:

mapMaker - new property value

See Also:

getMapMaker()

getMaxZoom

public double getMaxZoom()

Returns value of maxZoom property.

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

Returns:

property value

See Also:

setMaxZoom(double)

setMaxZoom

public void setMaxZoom(double zoom)

Sets new value for maxZoom property.

Parameters:

zoom - new property value

See Also:

getMaxZoom()

getMinZoom

public double getMinZoom()

Returns value of minZoom property.

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

Returns:

property value

See Also:

setMinZoom(double)

setMinZoom

public void setMinZoom(double zoom)

Sets new value for minZoom property.

Parameters:

zoom - new property value

See Also:

getMinZoom()

getNoClear

public boolean getNoClear()

Returns value of noClear property.

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

Returns:

property value

See Also:

setNoClear(boolean)

setNoClear

public void setNoClear(boolean noClear)

Sets new value for noClear property.

Parameters:

noClear - new property value

See Also:

getNoClear()

getOverviewMapControl

public boolean getOverviewMapControl()

Returns value of overviewMapControl property.

Contains the enabled/disabled state of the Overview Map control.

Returns:

property value

See Also:

setOverviewMapControl(boolean)

setOverviewMapControl

public void setOverviewMapControl(boolean value)

Sets new value for overviewMapControl property.

Parameters:

value - new property value

See Also:

getOverviewMapControl()

getOverviewMapControlOptions

public OverviewMapControlOptions getOverviewMapControlOptions()

Returns value of overviewMapControlOptions property.

Represents the display options for the Overview Map control.

Returns:

property value

See Also:

setOverviewMapControlOptions(com.teamdev.jxmaps.OverviewMapControlOptions)

setOverviewMapControlOptions

public void setOverviewMapControlOptions(OverviewMapControlOptions options)

Sets new value for overviewMapControlOptions property.

Parameters:

options - new property value

See Also:

getOverviewMapControlOptions()

getPanControl

public boolean getPanControl()

Returns value of panControl property.

Contains the enabled/disabled state of the Pan control.

Returns:

property value

See Also:

setPanControl(boolean)

setPanControl

public void setPanControl(boolean value)

Sets new value for panControl property.

Parameters:

value - new property value

See Also:

getPanControl()

getPanControlOptions

public PanControlOptions getPanControlOptions()

Returns value of panControlOptions property.

Represents the display options for the Pan control.

Returns:

property value

See Also:

setPanControlOptions(com.teamdev.jxmaps.PanControlOptions)

setPanControlOptions

public void setPanControlOptions(PanControlOptions options)

Sets new value for panControlOptions property.

Parameters:

options - new property value

See Also:

getPanControlOptions()

getRotateControl

public boolean getRotateControl()

Returns value of rotateControl property.

Contains the enabled/disabled state of the Rotate control.

Returns:

property value

See Also:

setRotateControl(boolean)

setRotateControl

public void setRotateControl(boolean value)

Sets new value for rotateControl property.

Parameters:

value - new property value

See Also:

getRotateControl()

getRotateControlOptions

public RotateControlOptions getRotateControlOptions()

Returns value of rotateControlOptions property.

Represents the display options for the Rotate control.

Returns:

property value

See Also:

setRotateControlOptions(com.teamdev.jxmaps.RotateControlOptions)

setRotateControlOptions

public void setRotateControlOptions(RotateControlOptions options)

Sets new value for rotateControlOptions property.

Parameters:

options - new property value

See Also:

getRotateControlOptions()

getScaleControl

public boolean getScaleControl()

Returns value of scaleControl property.

Contains the initial enabled/disabled state of the Scale control.

Returns:

property value

See Also:

setScaleControl(boolean)

setScaleControl

public void setScaleControl(boolean value)

Sets new value for scaleControl property.

Parameters:

value - new property value

See Also:

getScaleControl()

getScaleControlOptions

public ScaleControlOptions getScaleControlOptions()

Returns value of scaleControlOptions property.

Represents the initial display options for the Scale control.

Returns:

property value

See Also:

setScaleControlOptions(com.teamdev.jxmaps.ScaleControlOptions)

setScaleControlOptions

public void setScaleControlOptions(ScaleControlOptions options)

Sets new value for scaleControlOptions property.

Parameters:

options - new property value

See Also:

getScaleControlOptions()

getScrollWheel

public boolean getScrollWheel()

Returns value of scrollWheel property.

If false, disables scrollwheel zooming on the map. The scrollwheel is enabled by default.

Returns:

property value

See Also:

setScrollWheel(boolean)

setScrollWheel

public void setScrollWheel(boolean value)

Sets new value for scrollwheel property.

Parameters:

value - new property value

See Also:

getScrollWheel()

getStreetView

public StreetViewPanorama getStreetView()

Returns value of streetView property.

Contains a StreetViewPanorama object 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.

Returns:

property value

See Also:

setStreetView(com.teamdev.jxmaps.StreetViewPanorama)

setStreetView

public void setStreetView(StreetViewPanorama streetView)

Sets new value for streetView property.

Parameters:

streetView - new property value

See Also:

getStreetView()

getStreetViewControl

public boolean getStreetViewControl()

Returns value of streetViewControl property.

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

Returns:

property value

See Also:

setStreetViewControl(boolean)

setStreetViewControl

public void setStreetViewControl(boolean value)

Sets new value for streetViewControl property.

Parameters:

value - new property value

See Also:

getStreetViewControl()

getStreetViewControlOptions

public StreetViewControlOptions getStreetViewControlOptions()

Returns value of streetViewControlOptions property.

Represents the initial display options for the Street View Pegman control.

Returns:

property value

See Also:

setStreetViewControlOptions(com.teamdev.jxmaps.StreetViewControlOptions)

setStreetViewControlOptions

public void setStreetViewControlOptions(StreetViewControlOptions options)

Sets new value for streetViewControlOptions property.

Parameters:

options - new property value

See Also:

getStreetViewControlOptions()

getStyles

public MapTypeStyle[] getStyles()

Returns value of styles property.

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.

Returns:

property value

See Also:

setStyles(com.teamdev.jxmaps.MapTypeStyle[])

setStyles

public void setStyles(MapTypeStyle[] styles)

Sets new value for styles property.

Parameters:

styles - new property value

See Also:

getStyles()

getTilt

public double getTilt()

Returns value of tilt property.

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.

Returns:

property value

See Also:

setTilt(double)

setTilt

public void setTilt(double tilt)

Sets new value for tilt property.

Parameters:

tilt - new property value

See Also:

getTilt()

getZoom

public double getZoom()

Returns value of zoom property.

Contains the initial Map zoom level. Required.

Returns:

property value

See Also:

setZoom(double)

setZoom

public void setZoom(double value)

Sets new value for zoom property.

Parameters:

value - new property value

See Also:

getZoom()

getZoomControl

public boolean getZoomControl()

Returns value of zoomControl property.

Contains the enabled/disabled state of the Zoom control.

Returns:

property value

See Also:

setZoomControl(boolean)

setZoomControl

public void setZoomControl(boolean value)

Sets new value for zoomControl property.

Parameters:

value - new property value

See Also:

getZoomControl()

getZoomControlOptions

public ZoomControlOptions getZoomControlOptions()

Returns value of zoomControlOptions property.

Represents the display options for the Zoom control.

Returns:

property value

See Also:

setZoomControlOptions(com.teamdev.jxmaps.ZoomControlOptions)

setZoomControlOptions

public void setZoomControlOptions(ZoomControlOptions options)

Sets new value for zoomControlOptions property.

Parameters:

options - new property value

See Also:

getZoomControlOptions()

getMapTypeControl

public boolean getMapTypeControl()

Returns value of mapTypeControl property.

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

Returns:

property value

See Also:

setMapTypeControl(boolean)

setMapTypeControl

public void setMapTypeControl(boolean value)

Sets new value for mapTypeControl property.

Parameters:

value - new property value

See Also:

getMapTypeControl()

getMapTypeId

public MapTypeId getMapTypeId()

Returns value of mapTypeId property.

Contains the initial Map mapTypeId. Defaults to ROADMAP.

Returns:

property value

See Also:

setMapTypeId(com.teamdev.jxmaps.MapTypeId)

setMapTypeId

public void setMapTypeId(MapTypeId typeId)

Sets new value for mapTypeId property.

Parameters:

typeId - new property value

See Also:

getMapTypeId()

getMapTypeControlOptions

public MapTypeControlOptions getMapTypeControlOptions()

Returns value of mapTypeControlOptions property.

Contains the initial display options for the Map type control.

Returns:

property value

See Also:

setMapTypeControlOptions(com.teamdev.jxmaps.MapTypeControlOptions)

setMapTypeControlOptions

public void setMapTypeControlOptions(MapTypeControlOptions options)

Sets new value for mapTypeControlOptions property.

Parameters:

options - new property value

See Also:

getMapTypeControlOptions()