public final class

TileOverlayOptions

extends Object
java.lang.Object
   ↳ com.amazon.geo.mapsv2.model.TileOverlayOptions

Class Overview

An object for defining the initial options for a TileOverlay object. Use this to define all the properties of a TileOverlay before calling the addTileOverlay(TileOverlayOptions) method to add the TileOverlay to the map.

Modifying TileOverlayOptions after the TileOverlay has been added to the map has no effect on the appearance of the TileOverlay.

Note that TileOverlayOptions methods do not need to be called on the main thread.

Summary

Public Constructors
TileOverlayOptions()
Creates a new TileOverlayOptions object with default values.
Public Methods
int describeContents()
TileOverlayOptions fadeIn(boolean fadeIn)
Sets whether tiles for the new TileOverlay should fade in or display instantly with no fade effect.
boolean getFadeIn()
Retrieves a boolean value indicating whether the tiles for the new TileOverlay should fade in.
TileProvider getTileProvider()
Gets the TileProvider to use for the new TileOverlay.
float getZIndex()
Gets the z-index to use for the new TileOverlay.
boolean isVisible()
Retrieves a boolean value indicating whether the new TileOverlay is visible or hidden.
TileOverlayOptions tileProvider(TileProvider tileProvider)
Sets the TileProvider to use for the new TileOverlay.
TileOverlayOptions visible(boolean visible)
Sets the visibility to use for the new TileOverlay.
void writeToParcel(Parcel out, int flags)
TileOverlayOptions zIndex(float zIndex)
Sets the z-index to use for the new the TileOverlay.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public TileOverlayOptions ()

Creates a new TileOverlayOptions object with default values.

Public Methods

public int describeContents ()

public TileOverlayOptions fadeIn (boolean fadeIn)

Sets whether tiles for the new TileOverlay should fade in or display instantly with no fade effect.

Parameters
fadeIn true to fade in the tiles, or false to display the tiles instantly with no fade effect.
Returns
  • This TileOverlayOptions object.

public boolean getFadeIn ()

Retrieves a boolean value indicating whether the tiles for the new TileOverlay should fade in.

Returns
  • true to fade in the tiles, or false to display the tiles instantly with no fade effect.

public TileProvider getTileProvider ()

Gets the TileProvider to use for the new TileOverlay. This is the provider set with tileProvider(TileProvider).

Returns
  • The TileProvider set for the new TileOverlay

public float getZIndex ()

Gets the z-index to use for the new TileOverlay. See zIndex(float) for more information about the z-index.

Returns
  • The tile overlay's z-index.

public boolean isVisible ()

Retrieves a boolean value indicating whether the new TileOverlay is visible or hidden.

Returns
  • true if the TileOverlay is visible, or false if it is invisible.

public TileOverlayOptions tileProvider (TileProvider tileProvider)

Sets the TileProvider to use for the new TileOverlay.

Parameters
tileProvider The TileProvider to use for this tile overlay.
Returns
  • This TileOverlayOptions object.

public TileOverlayOptions visible (boolean visible)

Sets the visibility to use for the new TileOverlay. The default value is true.

Parameters
visible true to make the TileOverlay visible, or false to make it invisible.
Returns
  • This TileOverlayOptions object.

public void writeToParcel (Parcel out, int flags)

public TileOverlayOptions zIndex (float zIndex)

Sets the z-index to use for the new the TileOverlay. Z-index determines the order in which overlays are drawn. Overlays with higher indices are drawn over overlays with lower indices. Overlays with the same z-index are drawn in an arbitrary order.

Overlays that are affected by z-index include GroundOverlay, TileOverlay, Circle, Polyline, and Polygon.

Marker overlays are not affected by the z-index of other overlays.

The default value is zero.

Parameters
zIndex The z-index for the new TileOverlay.
Returns
  • This TileOverlayOptions object.