MBTiles (Groovy Documentation)

geoscript.layer.MBTiles

```
class MBTiles
extends ImageTileLayer
```
The MBTiles TileLayer
Authors:
Jared Erickson

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`MBTiles.Factory`	The MBTiles TileLayerFactory

Properties Summary

Properties
Type	Name and description
`MBTilesFile`	`tiles` The GeoTools MBTilesFile

Constructor Summary

Constructors
Constructor and description
`MBTiles (java.io.File file)` Create a new MBTilesLayer with a existing File
`MBTiles (java.lang.String file)` Create a new MBTilesLayer with a existing File
`MBTiles (java.util.Map options, java.io.File file, java.lang.String name, java.lang.String description)` Create a new MBTilesLayer with a new File
`MBTiles (java.util.Map options, java.lang.String fileName, java.lang.String name, java.lang.String description)` Create a new MBTilesLayer with a new File

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`close()`
	`void`	`delete(ImageTile t)` Delete a Tile
	`void`	`delete(TileCursor<ImageTile> tiles)` Delete all Tiles in the TileCursor
	`ImageTile`	`get(long z, long x, long y)`
	`int`	`getMaxZoom()` Get the maximum zoom level of the tiles present.
	`java.util.Map<java.lang.String, java.lang.String>`	`getMetadata()` Get metadata (type, name, description, format, version, attribution, bounds)
	`int`	`getMinZoom()` Get the minimum zoom level of the tiles present.
	`Pyramid`	`getPyramid()`
	`java.util.List<java.util.Map>`	`getTileCounts()` Get the number of tiles per zoom level.
	`void`	`put(ImageTile t)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class ImageTileLayer`	`getMapLayers, getRaster, getRaster, getRaster`

- Property Detail
  - MBTilesFile tiles
    
    The GeoTools MBTilesFile
- Constructor Detail
  - MBTiles(java.io.File file)
    
    Create a new MBTilesLayer with a existing File
    Parameters:
    file - The existing File
  - MBTiles(java.lang.String file)
    
    Create a new MBTilesLayer with a existing File
    Parameters:
    file - The existing File name
  - MBTiles(java.util.Map options, java.io.File file, java.lang.String name, java.lang.String description)
    
    Create a new MBTilesLayer with a new File
    Parameters:
    options - The optional named parameters
    
    type = The type of layer (base_layer is the default or overlay)
    
    version = The version number (1.0 is the default)
    
    format = The image format (png is the default or jpeg)
    
    attribution = The attributes
    file - The new File
    name - The name of the layer
    description - The description of the layer
  - MBTiles(java.util.Map options, java.lang.String fileName, java.lang.String name, java.lang.String description)
    
    Create a new MBTilesLayer with a new File
    Parameters:
    options - The optional named parameters
    
    type = The type of layer (base_layer is the default or overlay)
    
    version = The version number (1.0 is the default)
    
    format = The image format (png is the default or jpeg)
    
    attribution = The attributes
    file - The new File name
    name - The name of the layer
    description - The description of the layer
- Method Detail
  - @java.lang.Override void close()
  - @java.lang.Override void delete(ImageTile t)
    
    Delete a Tile
    Parameters:
    t - The Tile
  - @java.lang.Override void delete(TileCursor<ImageTile> tiles)
    
    Delete all Tiles in the TileCursor
    Parameters:
    tiles - The TileCursor
  - @java.lang.Override ImageTile get(long z, long x, long y)
  - int getMaxZoom()
    
    Get the maximum zoom level of the tiles present.
    Returns:
    The maximum zoom level of the tile present
  - java.util.Map<java.lang.String, java.lang.String> getMetadata()
    
    Get metadata (type, name, description, format, version, attribution, bounds)
    Returns:
    A Map of metadata
  - int getMinZoom()
    
    Get the minimum zoom level of the tiles present.
    Returns:
    The minimum zoom level of the tile present
  - @java.lang.Override Pyramid getPyramid()
  - java.util.List<java.util.Map> getTileCounts()
    
    Get the number of tiles per zoom level.
    Returns:
    A List of Maps with zoom, tiles, total, and percent keys
  - @java.lang.Override void put(ImageTile t)

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class MBTiles

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

MBTilesFile tiles

Constructor Detail

MBTiles(java.io.File file)

MBTiles(java.lang.String file)

MBTiles(java.util.Map options, java.io.File file, java.lang.String name, java.lang.String description)

MBTiles(java.util.Map options, java.lang.String fileName, java.lang.String name, java.lang.String description)

Method Detail

@java.lang.Override void close()

@java.lang.Override void delete(ImageTile t)

@java.lang.Override void delete(TileCursor<ImageTile> tiles)

@java.lang.Override ImageTile get(long z, long x, long y)

int getMaxZoom()

java.util.Map<java.lang.String, java.lang.String> getMetadata()

int getMinZoom()

@java.lang.Override Pyramid getPyramid()

java.util.List<java.util.Map> getTileCounts()

@java.lang.Override void put(ImageTile t)