TileStache.Providers
index
/home/migurski/public_html/TileStache/TileStache/Providers.py

The provider bits of TileStache.
 
A Provider is the part of TileStache that actually renders imagery. A few default
providers are found here, but it's possible to define your own and pull them into
TileStache dynamically by class name.
 
Built-in providers:
- mapnik
- proxy
 
Example built-in provider, for JSON configuration file:
 
    "layer-name": {
        "provider": {"name": "mapnik", "mapfile": "style.xml"},
        ...
    }
 
Example external provider, for JSON configuration file:
 
    "layer-name": {
        "provider": {"class": "Module.Classname", "kwargs": {"frob": "yes"}},
        ...
    }
 
- The "class" value is split up into module and classname, and dynamically
  included. If this doesn't work for some reason, TileStache will fail loudly
  to let you know.
- The "kwargs" value is fed to the class constructor as a dictionary of keyword
  args. If your defined class doesn't accept any of these keyword arguments,
  TileStache will throw an exception.
 
A provider must signal that its rendered tiles can be cut up as images and
metatiles with the boolean property metatileOK. A provider should optionally
provide a renderTile() method for drawing single coordinates at a time, with
the following four arguments:
 
- width, height: in pixels
- srs: projection as Proj4 string.
  "+proj=longlat +ellps=WGS84 +datum=WGS84" is an example, 
  see http://spatialreference.org for more.
- coord: Coordinate object representing a single tile.
 
The only method that a provider currently must implement is renderArea(),
with the following seven arguments:
 
- width, height: in pixels
- srs: projection as Proj4 string.
  "+proj=longlat +ellps=WGS84 +datum=WGS84" is an example, 
  see http://spatialreference.org for more.
- xmin, ymin, xmax, ymax: coordinates of bounding box in projected coordinates.

 
Modules
       
TileStache.Geography
ModestMaps
PIL
mapnik

 
Classes
       
Mapnik
Proxy

 
class Mapnik
    Built-in Mapnik provider. Renders map images from Mapnik XML files.
 
This provider is identified by the name "mapnik" in the TileStache config.
 
Additional arguments:
 
- mapfile (required)
    Local file path to Mapnik XML file.
 
More information on Mapnik and Mapnik XML:
http://mapnik.org
http://trac.mapnik.org/wiki/XMLGettingStarted
http://trac.mapnik.org/wiki/XMLConfigReference
 
  Methods defined here:
__init__(self, layer, mapfile)
Initialize Mapnik provider with layer and mapfile.
 
XML mapfile keyword arg comes from TileStache config,
and is an absolute path by the time it gets here.
renderArea(self, width, height, srs, xmin, ymin, xmax, ymax)

Data and other attributes defined here:
metatileOK = True

 
class Proxy
    Proxy provider, to pass through and cache tiles from other places.
 
This provider is identified by the name "proxy" in the TileStache config.
 
Additional arguments:
 
- url (optional)
    URL template for remote tiles, for example:
    "http://tile.openstreetmap.org/{Z}/{X}/{Y}.png"
- provider (optional)
    Provider name string from Modest Maps built-ins.
    See ModestMaps.builtinProviders.keys() for a list.
    Example: "OPENSTREETMAP".
 
One of the above is required. When both are present, url wins.
 
Example configuration:
 
{
    "name": "proxy",
    "url": "http://tile.openstreetmap.org/{Z}/{X}/{Y}.png"
}
 
  Methods defined here:
__init__(self, layer, url=None, provider_name=None)
Initialize Proxy provider with layer and url.
renderArea(self, width, height, srs, xmin, ymin, xmax, ymax)
renderTile(self, width, height, srs, coord)

Data and other attributes defined here:
metatileOK = True

 
Functions
       
getProviderByName(name)
Retrieve a provider object by name.
 
Raise an exception if the name doesn't work out.