TileLayerOptions

java.lang.Object
- com.gwidgets.api.leaflet.options.TileLayerOptions

@JsType(isNative=true,
        namespace="<global>",
        name="Object")
public class TileLayerOptions
extends java.lang.Object

The Class TileLayerOptions.

Author:: Zakaria Amine

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TileLayerOptions.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`TileLayerOptions.Builder`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttribution()` Gets e.g.
`LatLngBounds`	`getBounds()` Gets whether the TileLayer only loads tiles that are in the given geographical bounds.
`java.lang.Boolean`	`getContinuousWorld()` Gets whether the tile coordinates won't be wrapped by world width (-180 to 180 longitude) or clamped to lie within world height (-90 to 90).
`java.lang.Boolean`	`getDetectRetina()` Gets the detect retina option is set default false
`java.lang.String`	`getErrorTileUrl()` Gets the URL to the tile image to show in place of the tile that failed to load.
`java.lang.Number`	`getMaxNativeZoom()` Gets the Maximum zoom number the tiles source has available.
`java.lang.Number`	`getMaxZoom()` Gets the max zoom.
`java.lang.Number`	`getMinZoom()` Gets the min zoom.
`java.lang.Boolean`	`getNoWrap()` Gets whether the tiles just won't load outside the world width (-180 to 180 longitude) instead of repeating.
`java.lang.Number`	`getOpacity()` Gets the opacity of the tile layer.
`java.lang.Boolean`	`getReuseTiles()` Gets whether all the tiles that are not visible after panning are placed in a reuse queue from which they will be fetched when new tiles become visible (as opposed to dynamically creating new ones).
`java.lang.String[]`	`getSubdomains()` Gets the Subdomains of the tile service.
`java.lang.Number`	`getTileSize()` Gets the Tile size (width and height in pixels, assuming tiles are square).
`java.lang.Boolean`	`getTms()` Gets whether If true, inverses Y axis numbering for tiles (turn this on for TMS services).
`java.lang.Boolean`	`getUnloadInvisibleTiles()` Gets whether all the tiles that are not visible after panning are removed (for better performance).
`java.lang.Boolean`	`getUpdateWhenIdle()` Gets whether the new tiles are loaded during panning, otherwise only after it (for better performance).
`java.lang.Number`	`getzIndex()` Gets The explicit zIndex of the tile layer.
`java.lang.Number`	`getZoomOffset()` Gets The zoom number used in tile URLs will be offset with this value.
`java.lang.Boolean`	`getZoomReverse()` Gets the zoom number used in tile URLs will be reversed (maxZoom - zoom instead of zoom).

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getMinZoom
```
@JsOverlay
public final java.lang.Number getMinZoom()
```
    Gets the min zoom.
    default 0
    
    Returns:
    
    the min zoom
  - getMaxZoom
```
@JsOverlay
public final java.lang.Number getMaxZoom()
```
    Gets the max zoom.
    default 18
    
    Returns:
    
    the max zoom
  - getMaxNativeZoom
```
@JsOverlay
public final java.lang.Number getMaxNativeZoom()
```
    Gets the Maximum zoom number the tiles source has available. If it is specified, the tiles on all zoom levels higher than maxNativeZoom will be loaded from maxNativeZoom level and auto-scaled.
    default null
    
    Returns:
    
    the max native zoom
  - getTileSize
```
@JsOverlay
public final java.lang.Number getTileSize()
```
    Gets the Tile size (width and height in pixels, assuming tiles are square).
    default 256
    
    Returns:
    
    the tile size
  - getSubdomains
```
@JsOverlay
public final java.lang.String[] getSubdomains()
```
    Gets the Subdomains of the tile service. Can be passed in the form of one string (where each letter is a subdomain name) or an array of strings.
    default 'abc'
    
    Returns:
    
    the subdomains
  - getErrorTileUrl
```
@JsOverlay
public final java.lang.String getErrorTileUrl()
```
    Gets the URL to the tile image to show in place of the tile that failed to load.
    default ""
    
    Returns:
    
    the error tile url
  - getAttribution
```
@JsOverlay
public final java.lang.String getAttribution()
```
    Gets e.g. "� Mapbox" � the string used by the attribution control, describes the layer data.
    default ""
    
    Returns:
    
    the attribution
  - getTms
```
@JsOverlay
public final java.lang.Boolean getTms()
```
    Gets whether If true, inverses Y axis numbering for tiles (turn this on for TMS services).
    default false
    
    Returns:
    
    the tms
  - getContinuousWorld
```
@JsOverlay
public final java.lang.Boolean getContinuousWorld()
```
    Gets whether the tile coordinates won't be wrapped by world width (-180 to 180 longitude) or clamped to lie within world height (-90 to 90). Use this if you use Leaflet for maps that don't reflect the real world (e.g. game, indoor or photo maps).
    default false
    
    Returns:
    
    the continuous world
  - getNoWrap
```
@JsOverlay
public final java.lang.Boolean getNoWrap()
```
    Gets whether the tiles just won't load outside the world width (-180 to 180 longitude) instead of repeating.
    default false
    
    Returns:
    
    the no wrap
  - getZoomOffset
```
@JsOverlay
public final java.lang.Number getZoomOffset()
```
    Gets The zoom number used in tile URLs will be offset with this value.
    default 0
    
    Returns:
    
    the zoom offset
  - getZoomReverse
```
@JsOverlay
public final java.lang.Boolean getZoomReverse()
```
    Gets the zoom number used in tile URLs will be reversed (maxZoom - zoom instead of zoom).
    default false
    
    Returns:
    
    the zoom reverse
  - getOpacity
```
@JsOverlay
public final java.lang.Number getOpacity()
```
    Gets the opacity of the tile layer.
    default 1.0
    
    Returns:
    
    the opacity
  - getzIndex
```
@JsOverlay
public final java.lang.Number getzIndex()
```
    Gets The explicit zIndex of the tile layer. Not set by default.
    default null
    
    Returns:
    
    the z index
  - getUnloadInvisibleTiles
```
@JsOverlay
public final java.lang.Boolean getUnloadInvisibleTiles()
```
    Gets whether all the tiles that are not visible after panning are removed (for better performance). true by default on mobile WebKit, otherwise false.
    default true
    
    Returns:
    
    the unload invisible tiles
  - getUpdateWhenIdle
```
@JsOverlay
public final java.lang.Boolean getUpdateWhenIdle()
```
    Gets whether the new tiles are loaded during panning, otherwise only after it (for better performance). true by default on mobile WebKit, otherwise false.
    default true
    
    Returns:
    
    the update when idle
  - getDetectRetina
```
@JsOverlay
public final java.lang.Boolean getDetectRetina()
```
    Gets the detect retina option is set
    default false
    
    Returns:
    
    the detect retina
  - getReuseTiles
```
@JsOverlay
public final java.lang.Boolean getReuseTiles()
```
    Gets whether all the tiles that are not visible after panning are placed in a reuse queue from which they will be fetched when new tiles become visible (as opposed to dynamically creating new ones).
    default false
    
    Returns:
    
    the reuse tiles
  - getBounds
```
@JsOverlay
public final LatLngBounds getBounds()
```
    Gets whether the TileLayer only loads tiles that are in the given geographical bounds.
    default null
    
    Returns:
    
    the bounds

Class TileLayerOptions

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getMinZoom

getMaxZoom

getMaxNativeZoom

getTileSize

getSubdomains

getErrorTileUrl

getAttribution

getTms

getContinuousWorld

getNoWrap

getZoomOffset

getZoomReverse

getOpacity

getzIndex

getUnloadInvisibleTiles

getUpdateWhenIdle

getDetectRetina

getReuseTiles

getBounds