GoogleMapOptions
Page Summary
GoogleMapOptions is a class used to configure a GoogleMap when adding it programmatically to an Android application.
These options can be passed to
MapFragment.newInstance(GoogleMapOptions)or theMapView.MapView(Context, GoogleMapOptions)constructor.Options can also be applied using custom XML tags when adding a map via XML.
The class includes methods to configure various map properties such as camera position, gestures, UI controls, and display settings like ambient mode and background color.
It also provides getter methods to retrieve the current settings of the GoogleMapOptions object.
Defines configuration GoogleMapOptions for aGoogleMap. These options can be used when adding a map to your application programmatically (as opposed to via XML). If you are using aMapFragment, you can pass these options in using the static factory method MapFragment.newInstance(GoogleMapOptions). If you are using aMapView, you can pass these options in using the constructor MapView.MapView(Context, GoogleMapOptions).
If you add a map using XML, then you can apply these options using custom XML tags.
Inherited Constant Summary
| int | CONTENTS_FILE_DESCRIPTOR | |
| int | PARCELABLE_WRITE_RETURN_VALUE |
Public Constructor Summary
GoogleMapOptions() Creates a new GoogleMapOptions object. |
Public Method Summary
| GoogleMapOptions | ambientEnabled(boolean enabled) Specifies whether ambient-mode styling should be enabled. |
| GoogleMapOptions | |
| GoogleMapOptions | camera(CameraPosition camera) Specifies the initial camera position for the map (specify null to use the default camera position). |
| GoogleMapOptions | compassEnabled(boolean enabled) Specifies whether the compass should be enabled. |
| staticGoogleMapOptions | createFromAttributes(Context context,AttributeSet attrs) Creates a GoogleMapsOptions from theAttributeSet. |
| Boolean | getAmbientEnabled() Returns the ambientEnabled option, ornull if unspecified. |
| Integer | getBackgroundColor() Returns the current backgroundColor for the map, ornull if unspecified. |
| CameraPosition | getCamera() Returns the camera option, or null if unspecified. |
| Boolean | getCompassEnabled() Returns the compassEnabled option, ornull if unspecified. |
| LatLngBounds | getLatLngBoundsForCameraTarget() Returns the LatLngBounds used to constrain the camera target, ornull if unspecified. |
| Boolean | getLiteMode() Returns the liteMode option, ornull if unspecified. |
| int | getMapColorScheme() Returns the mapColorScheme option, orScheme.LIGHT default if unspecified. |
| String | getMapId() Returns the mapId, ornull if unspecified. |
| Boolean | getMapToolbarEnabled() Returns the mapToolbarEnabled option, ornull if unspecified. |
| int | getMapType() Returns the mapType option, or-1 if unspecified. |
| Float | getMaxZoomPreference() Returns the maximum zoom level preference, or null if unspecified. |
| Float | getMinZoomPreference() Returns the minimum zoom level preference, or null if unspecified. |
| Boolean | getRotateGesturesEnabled() Returns the rotateGesturesEnabled option, ornull if unspecified. |
| Boolean | getScrollGesturesEnabled() Returns the scrollGesturesEnabled option, ornull if unspecified. |
| Boolean | getScrollGesturesEnabledDuringRotateOrZoom() Returns the scrollGesturesEnabledDuringRotateOrZoom option, ornull if unspecified. |
| Boolean | getTiltGesturesEnabled() Returns the tiltGesturesEnabled option, ornull if unspecified. |
| Boolean | getUseViewLifecycleInFragment() Returns the useViewLifecycleInFragment option, ornull if unspecified. |
| Boolean | getZOrderOnTop() Returns the zOrderOnTop option, ornull if unspecified. |
| Boolean | getZoomControlsEnabled() Returns the zoomControlsEnabled option, ornull if unspecified. |
| Boolean | getZoomGesturesEnabled() Returns the zoomGesturesEnabled option, ornull if unspecified. |
| GoogleMapOptions | latLngBoundsForCameraTarget(LatLngBounds llbounds) Specifies a LatLngBounds to constrain the camera target, so that when users scroll and pan the map, the camera target does not move outside these bounds. |
| GoogleMapOptions | liteMode(boolean enabled) Specifies whether the map should be created in lite mode. |
| GoogleMapOptions | mapColorScheme(int mapColorScheme) Specifies a change to the initial map color scheme, default is MapColorScheme.LIGHT. |
| GoogleMapOptions | |
| GoogleMapOptions | mapToolbarEnabled(boolean enabled) Specifies whether the mapToolbar should be enabled. |
| GoogleMapOptions | mapType(int mapType) Specifies a change to the initial map type. |
| GoogleMapOptions | maxZoomPreference(float maxZoomPreference) Specifies a preferred upper bound for camera zoom. |
| GoogleMapOptions | minZoomPreference(float minZoomPreference) Specifies a preferred lower bound for camera zoom. |
| GoogleMapOptions | rotateGesturesEnabled(boolean enabled) Specifies whether rotate gestures should be enabled. |
| GoogleMapOptions | scrollGesturesEnabled(boolean enabled) Specifies whether scroll gestures should be enabled. |
| GoogleMapOptions | scrollGesturesEnabledDuringRotateOrZoom(boolean enabled) Specifies whether scroll gestures should be enabled during rotate and zoom gestures. |
| GoogleMapOptions | tiltGesturesEnabled(boolean enabled) Specifies whether tilt gestures should be enabled. |
| String | toString() |
| GoogleMapOptions | useViewLifecycleInFragment(boolean useViewLifecycleInFragment) When using a MapFragment, this flag specifies whether the lifecycle of the map should be tied to the fragment's view or the fragment itself. |
| void | writeToParcel(Parcel out, int flags) |
| GoogleMapOptions | zOrderOnTop(boolean zOrderOnTop) Control whether the map view's surface is placed on top of its window. |
| GoogleMapOptions | zoomControlsEnabled(boolean enabled) Specifies whether the zoom controls should be enabled. |
| GoogleMapOptions | zoomGesturesEnabled(boolean enabled) Specifies whether zoom gestures should be enabled. |
Inherited Method Summary
| abstract int | describeContents() |
| abstract void | writeToParcel(Parcel arg0, int arg1) |
Public Constructors
publicGoogleMapOptions()
Creates a new GoogleMapOptions object.
Public Methods
publicGoogleMapOptionsambientEnabled(boolean enabled)
Specifies whether ambient-mode styling should be enabled. The default value isfalse. When enabled, ambient-styled maps can be displayed when an Ambiactive device enters ambient mode.
publicGoogleMapOptionsbackgroundColor(Integer backgroundColor)
Sets the map background color. This is the color that shows underneath map tiles and displays whenever the renderer does not have a tile available for a portion of the viewport.
Parameters
| backgroundColor | the color to show in the background of the map. Ifnull is supplied then the map uses the default renderer background color. |
|---|
publicGoogleMapOptionscamera(CameraPosition camera)
Specifies the initial camera position for the map (specify null to use the default camera position).
publicGoogleMapOptionscompassEnabled(boolean enabled)
Specifies whether the compass should be enabled. See UiSettings.setCompassEnabled(boolean) for more details. The default value istrue.
public staticGoogleMapOptionscreateFromAttributes(Context context,AttributeSet attrs)
Creates aGoogleMapsOptions from theAttributeSet.
publicBooleangetAmbientEnabled()
Returns theambientEnabled option, ornull if unspecified.
publicIntegergetBackgroundColor()
Returns the currentbackgroundColor for the map, ornull if unspecified.
publicCameraPositiongetCamera()
Returns the camera option, ornull if unspecified.
publicBooleangetCompassEnabled()
Returns thecompassEnabled option, ornull if unspecified.
publicLatLngBoundsgetLatLngBoundsForCameraTarget()
Returns theLatLngBounds used to constrain the camera target, ornull if unspecified.
publicBooleangetLiteMode()
Returns theliteMode option, ornull if unspecified.
public intgetMapColorScheme()
Returns themapColorScheme option, orScheme.LIGHT default if unspecified.
publicStringgetMapId()
Returns themapId, ornull if unspecified.
publicBooleangetMapToolbarEnabled()
Returns themapToolbarEnabled option, ornull if unspecified.
public intgetMapType()
Returns themapType option, or-1 if unspecified.
publicFloatgetMaxZoomPreference()
Returns the maximum zoom level preference, ornull if unspecified.
publicFloatgetMinZoomPreference()
Returns the minimum zoom level preference, ornull if unspecified.
publicBooleangetRotateGesturesEnabled()
Returns therotateGesturesEnabled option, ornull if unspecified.
publicBooleangetScrollGesturesEnabled()
Returns thescrollGesturesEnabled option, ornull if unspecified.
publicBooleangetScrollGesturesEnabledDuringRotateOrZoom()
Returns thescrollGesturesEnabledDuringRotateOrZoom option, ornull if unspecified.
publicBooleangetTiltGesturesEnabled()
Returns thetiltGesturesEnabled option, ornull if unspecified.
publicBooleangetUseViewLifecycleInFragment()
Returns theuseViewLifecycleInFragment option, ornull if unspecified.
publicBooleangetZOrderOnTop()
Returns thezOrderOnTop option, ornull if unspecified.
publicBooleangetZoomControlsEnabled()
Returns thezoomControlsEnabled option, ornull if unspecified.
publicBooleangetZoomGesturesEnabled()
Returns thezoomGesturesEnabled option, ornull if unspecified.
publicGoogleMapOptionslatLngBoundsForCameraTarget(LatLngBounds llbounds)
Specifies a LatLngBounds to constrain the camera target, so that when users scroll and pan the map, the camera target does not move outside these bounds.
See GoogleMap.setLatLngBoundsForCameraTarget(LatLngBounds) for details.
publicGoogleMapOptionsliteMode(boolean enabled)
Specifies whether the map should be created in lite mode. The default value isfalse. If lite mode is enabled, maps will load as static images. This improves performance in the case where a lot of maps need to be displayed at the same time, for example in a scrolling list, however lite-mode maps cannot be panned or zoomed by the user, or tilted or rotated at all.
publicGoogleMapOptionsmapColorScheme(int mapColorScheme)
Specifies a change to the initial map color scheme, default isMapColorScheme.LIGHT.
publicGoogleMapOptionsmapId(String mapId)
Specifies the map's ID.
publicGoogleMapOptionsmapToolbarEnabled(boolean enabled)
Specifies whether the mapToolbar should be enabled. See UiSettings.setMapToolbarEnabled(boolean) for more details. The default value istrue.
publicGoogleMapOptionsmapType(int mapType)
Specifies a change to the initial map type.
publicGoogleMapOptionsmaxZoomPreference(float maxZoomPreference)
Specifies a preferred upper bound for camera zoom.
See GoogleMap.setMaxZoomPreference(float) for details.
publicGoogleMapOptionsminZoomPreference(float minZoomPreference)
Specifies a preferred lower bound for camera zoom.
See GoogleMap.setMinZoomPreference(float) for details.
publicGoogleMapOptionsrotateGesturesEnabled(boolean enabled)
Specifies whether rotate gestures should be enabled. See UiSettings.setRotateGesturesEnabled(boolean) for more details. The default value istrue.
publicGoogleMapOptionsscrollGesturesEnabled(boolean enabled)
Specifies whether scroll gestures should be enabled. See UiSettings.setScrollGesturesEnabled(boolean) for more details. The default value istrue.
publicGoogleMapOptionsscrollGesturesEnabledDuringRotateOrZoom(boolean enabled)
Specifies whether scroll gestures should be enabled during rotate and zoom gestures. See UiSettings.setScrollGesturesEnabledDuringRotateOrZoom(boolean) for more details. The default value istrue.
publicGoogleMapOptionstiltGesturesEnabled(boolean enabled)
Specifies whether tilt gestures should be enabled. See UiSettings.setTiltGesturesEnabled(boolean) for more details. The default value istrue.
publicStringtoString()
publicGoogleMapOptionsuseViewLifecycleInFragment(boolean useViewLifecycleInFragment)
When using aMapFragment, this flag specifies whether the lifecycle of the map should be tied to the fragment's view or the fragment itself. The default value isfalse, tying the lifecycle of the map to the fragment.
Using the lifecycle of the fragment allows faster rendering of the map when the fragment is detached and reattached, because the underlying GL context is preserved. This has the cost that detaching the fragment, but not destroying it, will not release memory used by the map.
Using the lifecycle of a fragment's view means that a map is not reused when the fragment is detached and reattached. This will cause the map to re-render from scratch, which can take a few seconds. It also means that while a fragment is detached, and therefore has no view, allGoogleMap methods will throwNullPointerException.
public voidwriteToParcel(Parcel out, int flags)
publicGoogleMapOptionszOrderOnTop(boolean zOrderOnTop)
Control whether the map view's surface is placed on top of its window. See SurfaceView.setZOrderOnTop(boolean) for more details. Note that this will cover all other views that could appear on the map (e.g., the zoom controls, the my location button).
publicGoogleMapOptionszoomControlsEnabled(boolean enabled)
Specifies whether the zoom controls should be enabled. See UiSettings.setZoomControlsEnabled(boolean) for more details. The default value istrue.
publicGoogleMapOptionszoomGesturesEnabled(boolean enabled)
Specifies whether zoom gestures should be enabled. See UiSettings.setZoomGesturesEnabled(boolean) for more details. The default value istrue.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-31 UTC.