OSM (Groovy Documentation)

geoscript.layer.OSM

```
class OSM
extends ImageTileLayer
```
A Open Street Map TileLayer that is ready only.
Authors:
Jared Erickson

Nested Class Summary

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

Properties Summary

Properties
Type	Name and description
`java.util.List`	`baseUrls` The base URL for OSM map tiles
`java.lang.String`	`imageType` The image type

Constructor Summary

Constructors
Constructor and description
`OSM ()` Create an OSM TileLayer with the default base URL
`OSM (java.lang.String name, java.util.List baseUrls)` Create an OSM TileLayer with a default base URL
`OSM (java.lang.String name, java.lang.String baseUrl)` Create an OSM TileLayer with a default base URL

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`close()` Close the TileLayer
	`void`	`delete(ImageTile t)` Delete a Tile
	`ImageTile`	`get(long z, long x, long y)` Get a Tile
	`Pyramid`	`getPyramid()` Get the Pyramid
	`static OSM`	`getWellKnownOSM(java.lang.String name)` Get a well known OSM Layer.
	`void`	`put(ImageTile t)` Add a Tile

Inherited Methods Summary

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

- Property Detail
  - java.util.List baseUrls
    
    The base URL for OSM map tiles
  - java.lang.String imageType
    
    The image type
- Constructor Detail
  - OSM()
    
    Create an OSM TileLayer with the default base URL
  - OSM(java.lang.String name, java.util.List baseUrls)
    
    Create an OSM TileLayer with a default base URL
    Parameters:
    name - The name of the TileLayer
    baseUrls - The List of base URL for OSM map tiles
  - OSM(java.lang.String name, java.lang.String baseUrl)
    
    Create an OSM TileLayer with a default base URL
    Parameters:
    baseUrl - The base URL for OSM map tiles
- Method Detail
  - @java.lang.Override void close()
    
    Close the TileLayer
  - @java.lang.Override void delete(ImageTile t)
    
    Delete a Tile
    Parameters:
    t - The Tile
  - @java.lang.Override ImageTile get(long z, long x, long y)
    
    Get a Tile
    Parameters:
    z - The zoom level
    x - The column
    y - The row
    Returns:
    A Tile
  - @java.lang.Override Pyramid getPyramid()
    
    Get the Pyramid
    Returns:
    The Pyramid
  - static OSM getWellKnownOSM(java.lang.String name)
    
    Get a well known OSM Layer.
    Parameters:
    name - The name of the well known OSM Layer (stamen-toner, stamen-toner-lite, stamen-watercolor, mapquest-street, mapquest-satellite, or osm)
    Returns:
    An OSM Tile Layer
  - @java.lang.Override void put(ImageTile t)
    
    Add a Tile
    Parameters:
    t - The Tile

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class OSM

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.util.List baseUrls

java.lang.String imageType

Constructor Detail

OSM()

OSM(java.lang.String name, java.util.List baseUrls)

OSM(java.lang.String name, java.lang.String baseUrl)

Method Detail

@java.lang.Override void close()

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

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

@java.lang.Override Pyramid getPyramid()

static OSM getWellKnownOSM(java.lang.String name)

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