public final class

TileOverlayOptions

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

Class Overview

Defines options for a TileOverlay.

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
Public Constructors
TileOverlayOptions()
Creates a new set of tile overlay options.
Public Methods
TileOverlayOptions fadeIn(boolean fadeIn)
Specifies whether the tiles should fade in.
boolean getFadeIn()
Gets whether the tiles should fade in.
TileProvider getTileProvider()
Gets the tile provider set for this TileOverlayOptions object.
float getTransparency()
Gets the transparency set for this TileOverlayOptions object.
float getZIndex()
Gets the zIndex set for this TileOverlayOptions object.
boolean isVisible()
Gets the visibility setting for this TileOverlayOptions object.
TileOverlayOptions tileProvider(TileProvider tileProvider)
Specifies the tile provider to use for this tile overlay.
TileOverlayOptions transparency(float transparency)
Specifies the transparency of the tile overlay.
TileOverlayOptions visible(boolean visible)
Specifies the visibility for the tile overlay.
void writeToParcel(Parcel out, int flags)
TileOverlayOptions zIndex(float zIndex)
Specifies the tile overlay's zIndex, i.e., the order in which it will be drawn where overlays with larger values are drawn above those with lower values.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Public Constructors

public TileOverlayOptions ()

Creates a new set of tile overlay options.

Public Methods

public TileOverlayOptions fadeIn (boolean fadeIn)

Specifies whether the tiles should fade in. The default is true.

Parameters
fadeIn boolean
Returns
TileOverlayOptions this TileOverlayOptions object with a new visibility setting.

public boolean getFadeIn ()

Gets whether the tiles should fade in.

Returns
boolean true if the tiles are to fade in; false if it is not.

public TileProvider getTileProvider ()

Gets the tile provider set for this TileOverlayOptions object.

Returns
TileProvider the TileProvider of the tile overlay.

public float getTransparency ()

Gets the transparency set for this TileOverlayOptions object.

Returns
float the transparency of the tile overlay.

public float getZIndex ()

Gets the zIndex set for this TileOverlayOptions object.

Returns
float the zIndex of the tile overlay.

public boolean isVisible ()

Gets the visibility setting for this TileOverlayOptions object.

Returns
boolean true if the tile overlay is to be visible; false if it is not.

public TileOverlayOptions tileProvider (TileProvider tileProvider)

Specifies the tile provider to use for this tile overlay.

Parameters
tileProvider TileProvider: the TileProvider to use for this tile overlay.
Returns
TileOverlayOptions the object for which the method was called, with the new tile provider set.

public TileOverlayOptions transparency (float transparency)

Specifies the transparency of the tile overlay. The default transparency is 0 (opaque).

Parameters
transparency float: a float in the range [0..1] where 0 means that the tile overlay is opaque and 1 means that the tile overlay is transparent.
Returns
TileOverlayOptions this TileOverlayOptions object with a new transparency setting.
Throws
IllegalArgumentException if the transparency is outside the range [0..1].

public TileOverlayOptions visible (boolean visible)

Specifies the visibility for the tile overlay. The default visibility is true.

Parameters
visible boolean
Returns
TileOverlayOptions this TileOverlayOptions object with a new visibility setting.

public void writeToParcel (Parcel out, int flags)

Parameters
out Parcel
flags int

public TileOverlayOptions zIndex (float zIndex)

Specifies the tile overlay's zIndex, i.e., the order in which it will be drawn where overlays with larger values are drawn above those with lower values. See the documentation at the top of this class for more information about zIndex.

Parameters
zIndex float
Returns
TileOverlayOptions this TileOverlayOptions object with a new zIndex set.