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.
A map with all behaviors that were defined for this widget. The key is the name of the behavior, the value is the callback function that is invoked when the behavior is called.
The initial Map center.
List of overlay circular shapes added to this map.
When false, map icons are not clickable. A map icon
represents a point of interest, also known as a POI.
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.
Enables/disables all default UI buttons. May be overridden individually. Does not disable the keyboard controls, which are separately controlled by the google.maps.MapOptions.keyboardShortcuts option. Does not disable gesture controls, which are separately controlled by the google.maps.MapOptions.gestureHandling option.
Enables/disables zoom and center on double click. Enabled by default.
Note: This property is not
recommended. To disable zooming on double click, you can use the
gestureHandling property, and set it to "none".
If false, prevents the map from being dragged. Dragging is
enabled by default.
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;'.
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;'.
Defines if center and zoom should be calculated automatically to contain all markers on the map.
ID of the form to use for AJAX requests.
The enabled/disabled state of the Fullscreen control.
The display options for the Fullscreen control.
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."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.
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.
The client-side ID of the widget, with all parent naming containers, such as
myForm:myWidget. This is also the ID of the container HTML element for this widget. In case the widget needs
multiple container elements (such as Paginator), this may also be an array if IDs.
The current info window instance, if any info window was created yet.
HTML string with the contents of the info window, as fetched from the server.
Whether the map should allow fractional zoom levels. Listen to
isfractionalzoomenabled_changed to know when the default has
been set.
If false, prevents the map from being controlled by the
keyboard. Keyboard shortcuts are enabled by default.
The Map ID of the map. This parameter cannot be set or changed after a map is instantiated.
The initial enabled/disabled state of the Map type control.
The initial display options for the Map type control.
The initial Map mapTypeId. Defaults to ROADMAP.
A list of markers to display on the map.
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 zoom values are numbers from zero up to the supported
maximum
zoom level.
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 zoom values are numbers from zero up to the supported
maximum
zoom level.
If true, do not clear the contents of the Map div.
Javascript callback to execute when a point on map is clicked.
The enabled/disabled state of the Pan control.
Note: The Pan control is not available in the new set of controls introduced in v3.22 of the Google Maps JavaScript API. While using v3.22 and v3.23, you can choose to use the earlier set of controls rather than the new controls, thus making the Pan control available as part of the old control set. See What's New in the v3.22 Map Controls.
The display options for the Pan control.
Note: The Pan control is not available in the new set of controls introduced in v3.22 of the Google Maps JavaScript API. While using v3.22 and v3.23, you can choose to use the earlier set of controls rather than the new controls, thus making the Pan control available as part of the old control set. See What's New in the v3.22 Map Controls.
List of overlay polygonal shapes added to this map.
List of overlay polyline shapes added to this map.
An optional callback that is invoked
after this widget was created successfully, at the end of the init method. This is
usually specified via the widgetPostConstruct attribute on the JSF component. Note that this is also called
during a refresh (AJAX update).
An optional callback that is invoked after
this widget was refreshed after an AJAX update, at the end of the refresh method.
This is usually specified via the widgetPostRefresh attribute on the JSF component.
An optional callback that is invoked before
this widget is about to be destroyed, e.g. when the component was removed at the end of an AJAX update. This is
called at the beginning of the destroy method. This is usually specified via the
widgetPreDestroy attribute on the JSF component.
List of overlay rectangular shapes added to this map.
Defines a boundary that restricts the area of the map accessible to users. When set, a user can only pan and zoom while the camera view stays inside the limits of the boundary.
The enabled/disabled state of the Rotate control.
The display options for the Rotate control.
The initial enabled/disabled state of the Scale control.
The initial display options for the Scale control.
If false, disables zooming on the map using a mouse scroll
wheel. The scrollwheel is enabled by default.
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".
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.
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).
The initial display options for the Street View Pegman control.
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.
For vector maps, sets the angle of incidence of the map. The allowed
values are restricted depending on the zoom level of the map. For raster
maps, 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.
The name of the widget variables of this widget. The widget variable can be used to
access a widget instance by calling PF("myWidgetVar").
The initial Map zoom level. Valid zoom values are numbers from zero up to the supported maximum zoom level. Larger zoom values correspond to a higher resolution.
The enabled/disabled state of the Zoom control.
The display options for the Zoom control.
Generated using TypeDoc
The configuration for the GMap widget. You can access this configuration via BaseWidget.cfg. Please note that this configuration is usually meant to be read-only and should not be modified.