public final class TileOverlay
Represents a tile overlay. A tile overlay is a set of images to be displayed on a map. It can be transparent and enable you to add new functions to an existing map.
None.
None.
| Return type | Method name |
| void | clearTileCache() |
| boolean | equals(Object other) |
| boolean | getFadeIn() |
| String | getId() |
| float | getTransparency() |
| float | getZIndex() |
| int | hashCode() |
| boolean | isVisible() |
| void | remove() |
| void | setFadeIn(boolean fadeIn) |
| void | setTransparency(float transparency) |
| void | setVisible(boolean visible) |
| void | setZIndex(float zIndex) |
| Method |
| public void clearTileCache() |
| Clears the cache of a tile overlay. |
Parameters:
None.
Return:
None.
| Method |
| public boolean equals(Object other) |
| Checks whether a tile overlay object equals another. |
Parameters:
| Parameter name | Parameter desc |
| other | Name of another tile overlay object. |
Return:
| Return type | Parameter desc |
| boolean | If the tile overlay objects are equal, true is returned. Otherwise, false is returned. |
| Method |
| public boolean getFadeIn() |
| Checks whether a tile overlay fades in. |
Parameters:
None.
Return:
| Return type | Parameter desc |
| boolean | Whether a tile overlay fades in. |
| Method |
| public String getId() |
| Obtains the ID of a tile overlay on a map. The ID will be unique among all tile overlays on a map. |
Parameters:
None.
Return:
| Return type | Parameter desc |
| String | ID of a tile overlay. |
| Method |
| public float getTransparency() |
| Obtains the transparency of a tile overlay. |
Parameters:
None.
Return:
| Return type | Parameter desc |
| float | Transparency of a tile overlay. The value ranges from 0 (completely opaque) to 1 (completely transparent). |
| Method |
| public float getZIndex() |
| Obtains the z-index of a tile overlay. |
Parameters:
None.
Return:
| Return type | Parameter desc |
| float | Z-index, which indicates the overlapping order of a tile overlay. |
| Method |
| public int hashCode() |
| Obtains the hash code of a tile overlay. |
Parameters:
None.
Return:
| Return type | Parameter desc |
| int | Hash code of a tile overlay. |
| Method |
| public boolean isVisible() |
| Checks whether a tile overlay is visible. |
Parameters:
None.
Return:
| Return type | Parameter desc |
| boolean | If a tile overlay is visible, true is returned. Otherwise, false is returned. |
| Method |
| public void remove() |
| Removes a tile overlay from a map. |
Parameters:
None.
Return:
None.
| Method |
| public void setFadeIn(boolean fadeIn) |
| Specifies whether to make a tile overlay fade in. |
Parameters:
| Parameter name | Parameter desc |
| fadeIn | Indicates whether to make a tile overlay fade in. |
Return:
None.
| Method |
| public void setTransparency(float transparency) |
| Sets the transparency of a tile overlay. |
Parameters:
| Parameter name | Parameter desc |
| transparency | Transparency of a tile overlay. The value ranges from 0 (completely opaque) to 1 (completely transparent). |
Return:
None.
Parameters:
| Parameter name | Parameter desc |
| visible | If a tile overlay is visible, true is returned. Otherwise, false is returned. |
Return:
None.
Parameters:
| Parameter name | Parameter desc |
| zIndex | Z-index, which indicates the overlapping order of a tile overlay. |
Return:
None.