public final class

GoogleMapOptions

extends Object
implements Parcelable Parcelable
java.lang.Object
   ↳ com.google.android.gms.maps.GoogleMapOptions

Class Overview

Defines configuration GoogleMapOptions for a GoogleMap. These options can be used when adding a map to your application programmatically (as opposed to via XML). If you are using a MapFragment, you can pass these options in using the static factory method newInstance(GoogleMapOptions). If you are using a MapView, you can pass these options in using the constructor MapView(Context, GoogleMapOptions).

If you add a map using XML, then you can apply these options using custom XML tags.

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
Public Constructors
GoogleMapOptions()
Creates a new GoogleMapOptions object.
Public Methods
GoogleMapOptions ambientEnabled(boolean enabled)
Specifies whether ambient-mode styling should be enabled.
GoogleMapOptions camera(CameraPosition camera)
Specifies a the initial camera position for the map.
GoogleMapOptions compassEnabled(boolean enabled)
Specifies whether the compass should be enabled.
static GoogleMapOptions createFromAttributes(Context context, AttributeSet attrs)
Creates a GoogleMapsOptions from the AttributeSet.
Boolean getAmbientEnabled()
CameraPosition getCamera()
Boolean getCompassEnabled()
LatLngBounds getLatLngBoundsForCameraTarget()
Boolean getLiteMode()
Boolean getMapToolbarEnabled()
int getMapType()
Float getMaxZoomPreference()
Float getMinZoomPreference()
Boolean getRotateGesturesEnabled()
Boolean getScrollGesturesEnabled()
Boolean getTiltGesturesEnabled()
Boolean getUseViewLifecycleInFragment()
Boolean getZOrderOnTop()
Boolean getZoomControlsEnabled()
Boolean getZoomGesturesEnabled()
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 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 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.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Public Constructors

public GoogleMapOptions ()

Creates a new GoogleMapOptions object.

Public Methods

public GoogleMapOptions ambientEnabled (boolean enabled)

Specifies whether ambient-mode styling should be enabled. The default value is false. When enabled, ambient-styled maps can be displayed when an Ambiactive device enters ambient mode.

Parameters
enabled boolean
Returns
GoogleMapOptions

public GoogleMapOptions camera (CameraPosition camera)

Specifies a the initial camera position for the map.

Parameters
camera CameraPosition
Returns
GoogleMapOptions

public GoogleMapOptions compassEnabled (boolean enabled)

Specifies whether the compass should be enabled. See setCompassEnabled(boolean) for more details. The default value is true.

Parameters
enabled boolean
Returns
GoogleMapOptions

public static GoogleMapOptions createFromAttributes (Context context, AttributeSet attrs)

Creates a GoogleMapsOptions from the AttributeSet.

Parameters
context Context
attrs AttributeSet
Returns
GoogleMapOptions

public Boolean getAmbientEnabled ()

Returns
Boolean the ambientEnabled option, or null if unspecified.

public CameraPosition getCamera ()

Returns
CameraPosition the camera option, or null if unspecified.

public Boolean getCompassEnabled ()

Returns
Boolean the compassEnabled option, or null if unspecified.

public LatLngBounds getLatLngBoundsForCameraTarget ()

Returns
LatLngBounds the LatLngBounds used to constrain the camera target, or null if unspecified.

public Boolean getLiteMode ()

Returns
Boolean the liteMode option, or null if unspecified.

public Boolean getMapToolbarEnabled ()

Returns
Boolean the mapToolbarEnabled option, or null if unspecified.

public int getMapType ()

Returns
int the mapType option, or -1 if unspecified.

public Float getMaxZoomPreference ()

Returns
Float the maximum zoom level preference, or null if unspecified.

public Float getMinZoomPreference ()

Returns
Float the minimum zoom level preference, or null if unspecified.

public Boolean getRotateGesturesEnabled ()

Returns
Boolean the rotateGesturesEnabled option, or null if unspecified.

public Boolean getScrollGesturesEnabled ()

Returns
Boolean the scrollGesturesEnabled option, or null if unspecified.

public Boolean getTiltGesturesEnabled ()

Returns
Boolean the tiltGesturesEnabled option, or null if unspecified.

public Boolean getUseViewLifecycleInFragment ()

Returns
Boolean the useViewLifecycleInFragment option, or null if unspecified.

public Boolean getZOrderOnTop ()

Returns
Boolean the zOrderOnTop option, or null if unspecified.

public Boolean getZoomControlsEnabled ()

Returns
Boolean the zoomControlsEnabled option, or null if unspecified.

public Boolean getZoomGesturesEnabled ()

Returns
Boolean the zoomGesturesEnabled option, or null if unspecified.

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

See setLatLngBoundsForCameraTarget(LatLngBounds) for details.

Parameters
llbounds LatLngBounds
Returns
GoogleMapOptions

public GoogleMapOptions liteMode (boolean enabled)

Specifies whether the map should be created in lite mode. The default value is false. 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.

Parameters
enabled boolean
Returns
GoogleMapOptions

public GoogleMapOptions mapToolbarEnabled (boolean enabled)

Specifies whether the mapToolbar should be enabled. See setMapToolbarEnabled(boolean) for more details. The default value is true.

Parameters
enabled boolean
Returns
GoogleMapOptions

public GoogleMapOptions mapType (int mapType)

Specifies a change to the initial map type.

Parameters
mapType int
Returns
GoogleMapOptions

public GoogleMapOptions maxZoomPreference (float maxZoomPreference)

Specifies a preferred upper bound for camera zoom.

See setMaxZoomPreference(float) for details.

Parameters
maxZoomPreference float
Returns
GoogleMapOptions

public GoogleMapOptions minZoomPreference (float minZoomPreference)

Specifies a preferred lower bound for camera zoom.

See setMinZoomPreference(float) for details.

Parameters
minZoomPreference float
Returns
GoogleMapOptions

public GoogleMapOptions rotateGesturesEnabled (boolean enabled)

Specifies whether rotate gestures should be enabled. See setRotateGesturesEnabled(boolean) for more details. The default value is true.

Parameters
enabled boolean
Returns
GoogleMapOptions

public GoogleMapOptions scrollGesturesEnabled (boolean enabled)

Specifies whether scroll gestures should be enabled. See setScrollGesturesEnabled(boolean) for more details. The default value is true.

Parameters
enabled boolean
Returns
GoogleMapOptions

public GoogleMapOptions tiltGesturesEnabled (boolean enabled)

Specifies whether tilt gestures should be enabled. See setTiltGesturesEnabled(boolean) for more details. The default value is true.

Parameters
enabled boolean
Returns
GoogleMapOptions

public String toString ()

Returns
String

public 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. The default value is false, 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, all GoogleMap methods will throw NullPointerException.

Parameters
useViewLifecycleInFragment boolean
Returns
GoogleMapOptions

public void writeToParcel (Parcel out, int flags)

Parameters
out Parcel
flags int

public GoogleMapOptions zOrderOnTop (boolean zOrderOnTop)

Control whether the map view's surface is placed on top of its window. See 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).

Parameters
zOrderOnTop boolean
Returns
GoogleMapOptions

public GoogleMapOptions zoomControlsEnabled (boolean enabled)

Specifies whether the zoom controls should be enabled. See setZoomControlsEnabled(boolean) for more details. The default value is true.

Parameters
enabled boolean
Returns
GoogleMapOptions

public GoogleMapOptions zoomGesturesEnabled (boolean enabled)

Specifies whether zoom gestures should be enabled. See setZoomGesturesEnabled(boolean) for more details. The default value is true.

Parameters
enabled boolean
Returns
GoogleMapOptions