TileLayerOptions.Builder

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

Enclosing class:: TileLayerOptions

public static class TileLayerOptions.Builder
extends java.lang.Object

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TileLayerOptions.Builder`	`attribution(java.lang.String attribution)` e.g.
`TileLayerOptions.Builder`	`bounds(LatLngBounds bounds)` When this option is set, the TileLayer only loads tiles that are in the given geographical bounds.
`TileLayerOptions`	`build()` Builds the TileLayerOptions new instance
`TileLayerOptions.Builder`	`continuousWorld(java.lang.Boolean continuousWorld)` If set to true, the tile coordinates won't be wrapped by world width (-180 to 180 longitude) or clamped to lie within world height (-90 to 90).
`TileLayerOptions.Builder`	`detectRetina(java.lang.Boolean detectRetina)` If true and user is on a retina display, it will request four tiles of half the specified size and a bigger zoom level in place of one to utilize the high resolution.
`TileLayerOptions.Builder`	`errorTileUrl(java.lang.String errorTileUrl)` URL to the tile image to show in place of the tile that failed to load.
`TileLayerOptions.Builder`	`maxNativeZoom(java.lang.Number maxNativeZoom)` Maximum zoom number the tiles source has available.
`TileLayerOptions.Builder`	`maxZoom(java.lang.Number maxZoom)` Maximum zoom number.
`TileLayerOptions.Builder`	`minZoom(java.lang.Number minZoom)` Minimum zoom number.
`TileLayerOptions.Builder`	`noWrap(java.lang.Boolean noWrap)` If set to true, the tiles just won't load outside the world width (-180 to 180 longitude) instead of repeating.
`TileLayerOptions.Builder`	`opacity(java.lang.Number opacity)` The opacity of the tile layer.
`TileLayerOptions.Builder`	`reuseTiles(java.lang.Boolean reuseTiles)` If true, 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).
`TileLayerOptions.Builder`	`subdomains(java.lang.String[] subdomains)` Subdomains of the tile service.
`TileLayerOptions.Builder`	`tileSize(java.lang.Number tileSize)` Tile size (width and height in pixels, assuming tiles are square).
`TileLayerOptions.Builder`	`tms(java.lang.Boolean tms)` If true, inverses Y axis numbering for tiles (turn this on for TMS services).
`TileLayerOptions.Builder`	`unloadInvisibleTiles(java.lang.Boolean unloadInvisibleTiles)` If true, all the tiles that are not visible after panning are removed (for better performance).
`TileLayerOptions.Builder`	`updateWhenIdle(java.lang.Boolean updateWhenIdle)` If false, new tiles are loaded during panning, otherwise only after it (for better performance).
`TileLayerOptions.Builder`	`zIndex(java.lang.Number zIndex)` The explicit zIndex of the tile layer.
`TileLayerOptions.Builder`	`zoomOffset(java.lang.Number zoomOffset)` The zoom number used in tile URLs will be offset with this value.
`TileLayerOptions.Builder`	`zoomReverse(java.lang.Boolean zoomReverse)` If set to true, 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

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - minZoom
```
public TileLayerOptions.Builder minZoom(java.lang.Number minZoom)
```
    Minimum zoom number.
    default 0
    
    Parameters:
    
    minZoom - the min zoom
    
    Returns:
    
    the builder
  - maxZoom
```
public TileLayerOptions.Builder maxZoom(java.lang.Number maxZoom)
```
    Maximum zoom number.
    default 18
    
    Parameters:
    
    maxZoom - the max zoom
    
    Returns:
    
    the builder
  - maxNativeZoom
```
public TileLayerOptions.Builder maxNativeZoom(java.lang.Number maxNativeZoom)
```
    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
    
    Parameters:
    
    maxNativeZoom - the max native zoom
    
    Returns:
    
    the builder
  - tileSize
```
public TileLayerOptions.Builder tileSize(java.lang.Number tileSize)
```
    Tile size (width and height in pixels, assuming tiles are square).
    default 256
    
    Parameters:
    
    tileSize - the tile size
    
    Returns:
    
    the builder
  - subdomains
```
public TileLayerOptions.Builder subdomains(java.lang.String[] subdomains)
```
    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"}
    
    Parameters:
    
    subdomains - the subdomains
    
    Returns:
    
    the builder
  - errorTileUrl
```
public TileLayerOptions.Builder errorTileUrl(java.lang.String errorTileUrl)
```
    URL to the tile image to show in place of the tile that failed to load.
    default ""
    
    Parameters:
    
    errorTileUrl - the error tile url
    
    Returns:
    
    the builder
  - attribution
```
public TileLayerOptions.Builder attribution(java.lang.String attribution)
```
    e.g. "� Mapbox" � the string used by the attribution control, describes the layer data.
    default ""
    
    Parameters:
    
    attribution - the attribution
    
    Returns:
    
    the builder
  - tms
```
public TileLayerOptions.Builder tms(java.lang.Boolean tms)
```
    If true, inverses Y axis numbering for tiles (turn this on for TMS services).
    default true
    
    Parameters:
    
    tms - the tms
    
    Returns:
    
    the builder
  - continuousWorld
```
public TileLayerOptions.Builder continuousWorld(java.lang.Boolean continuousWorld)
```
    If set to true, 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
    
    Parameters:
    
    continuousWorld - the continuous world
    
    Returns:
    
    the builder
  - noWrap
```
public TileLayerOptions.Builder noWrap(java.lang.Boolean noWrap)
```
    If set to true, the tiles just won't load outside the world width (-180 to 180 longitude) instead of repeating. default false
    
    Parameters:
    
    noWrap - the no wrap
    
    Returns:
    
    the builder
  - zoomOffset
```
public TileLayerOptions.Builder zoomOffset(java.lang.Number zoomOffset)
```
    The zoom number used in tile URLs will be offset with this value.
    default 0
    
    Parameters:
    
    zoomOffset - the zoom offset
    
    Returns:
    
    the builder
  - zoomReverse
```
public TileLayerOptions.Builder zoomReverse(java.lang.Boolean zoomReverse)
```
    If set to true, the zoom number used in tile URLs will be reversed (maxZoom - zoom instead of zoom).
    default false
    
    Parameters:
    
    zoomReverse - the zoom reverse
    
    Returns:
    
    the builder
  - opacity
```
public TileLayerOptions.Builder opacity(java.lang.Number opacity)
```
    The opacity of the tile layer.
    default 1.0
    
    Parameters:
    
    opacity - the opacity
    
    Returns:
    
    the builder
  - zIndex
```
public TileLayerOptions.Builder zIndex(java.lang.Number zIndex)
```
    The explicit zIndex of the tile layer. Not set by default.
    default null
    
    Parameters:
    
    zIndex - the z index
    
    Returns:
    
    the builder
  - unloadInvisibleTiles
```
public TileLayerOptions.Builder unloadInvisibleTiles(java.lang.Boolean unloadInvisibleTiles)
```
    If true, all the tiles that are not visible after panning are removed (for better performance). true by default on mobile WebKit, otherwise false.
    default true
    
    Parameters:
    
    unloadInvisibleTiles - the unload invisible tiles
    
    Returns:
    
    the builder
  - updateWhenIdle
```
public TileLayerOptions.Builder updateWhenIdle(java.lang.Boolean updateWhenIdle)
```
    If false, new tiles are loaded during panning, otherwise only after it (for better performance). true by default on mobile WebKit, otherwise false.
    default true
    
    Parameters:
    
    updateWhenIdle - the update when idle
    
    Returns:
    
    the builder
  - detectRetina
```
public TileLayerOptions.Builder detectRetina(java.lang.Boolean detectRetina)
```
    If true and user is on a retina display, it will request four tiles of half the specified size and a bigger zoom level in place of one to utilize the high resolution.
    default false
    
    Parameters:
    
    detectRetina - the detect retina
    
    Returns:
    
    the builder
  - reuseTiles
```
public TileLayerOptions.Builder reuseTiles(java.lang.Boolean reuseTiles)
```
    If true, 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). This will in theory keep memory usage low and eliminate the need for reserving new memory whenever a new tile is needed.
    default false
    
    Parameters:
    
    reuseTiles - the reuse tiles
    
    Returns:
    
    the builder
  - bounds
```
public TileLayerOptions.Builder bounds(LatLngBounds bounds)
```
    When this option is set, the TileLayer only loads tiles that are in the given geographical bounds.
    default null
    
    Parameters:
    
    bounds - the bounds
    
    Returns:
    
    the builder
  - build
```
public TileLayerOptions build()
```
    Builds the TileLayerOptions new instance
    
    Returns:
    
    the tile layer options

Class TileLayerOptions.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

minZoom

maxZoom

maxNativeZoom

tileSize

subdomains

errorTileUrl

attribution

tms

continuousWorld

noWrap

zoomOffset

zoomReverse

opacity

zIndex

unloadInvisibleTiles

updateWhenIdle

detectRetina

reuseTiles

bounds

build