2009-03-30 05:20:00 +00:00
<?xml version="1.0" encoding="ascii"?>
< !DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" xml:lang = "en" lang = "en" >
< head >
< title > mapnik< / title >
< link rel = "stylesheet" href = "epydoc.css" type = "text/css" / >
< script type = "text/javascript" src = "epydoc.js" > < / script >
< / head >
< body bgcolor = "white" text = "black" link = "blue" vlink = "#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
< table class = "navbar" border = "0" width = "100%" cellpadding = "0"
bgcolor="#a0c0ff" cellspacing="0">
< tr valign = "middle" >
<!-- Home link -->
< th bgcolor = "#70b0f0" class = "navbar-select"
> Home < / th >
<!-- Tree link -->
< th > < a
href="module-tree.html">Trees< / a > < / th >
<!-- Index link -->
< th > < a
href="identifier-index.html">Indices< / a > < / th >
<!-- Help link -->
< th > < a
href="help.html">Help< / a > < / th >
<!-- Project homepage -->
< th class = "navbar" align = "right" width = "100%" >
< table border = "0" cellpadding = "0" cellspacing = "0" >
< tr > < th class = "navbar" align = "center"
>< a class = "navbar" target = "_top" href = "http://mapnik.org" > mapnik< / a > < / th >
< / tr > < / table > < / th >
< / tr >
< / table >
< table width = "100%" cellpadding = "0" cellspacing = "0" >
< tr valign = "top" >
< td width = "100%" >
< span class = "breadcrumbs" >
Package mapnik
< / span >
< / td >
< td >
< table cellpadding = "0" cellspacing = "0" >
<!-- hide/show private -->
< / table >
< / td >
< / tr >
< / table >
<!-- ==================== PACKAGE DESCRIPTION ==================== -->
< h1 class = "epydoc" > Package mapnik< / h1 > < p class = "nomargin-top" > < / p >
< pre class = "literalblock" >
Mapnik Python module.
Boost Python bindings to the Mapnik C++ shared library.
Several things happen when you do:
2009-11-08 17:02:17 +00:00
2009-03-30 05:20:00 +00:00
> > > import mapnik
1) Mapnik C++ objects are imported via the '__init__.py' from the '_mapnik.so' shared object
which references libmapnik.so (linux), libmapnik.dylib (mac), or libmapnik.dll (win).
2009-11-08 17:02:17 +00:00
2009-03-30 05:20:00 +00:00
2) The paths to the input plugins and font directories are imported from the 'paths.py'
file which was constructed and installed during SCons installation.
2009-07-08 22:33:16 +00:00
3) All available input plugins and TrueType fonts are automatically registered.
2009-03-30 05:20:00 +00:00
2009-11-08 17:02:17 +00:00
4) Boost Python metaclass injectors are used in the '__init__.py' to extend several
2009-03-30 05:20:00 +00:00
objects adding extra convenience when accessed via Python.
< / pre >
<!-- ==================== SUBMODULES ==================== -->
< a name = "section-Submodules" > < / a >
< table class = "summary" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr bgcolor = "#70b0f0" class = "table-header" >
< td align = "left" colspan = "2" class = "table-header" >
< span class = "table-header" > Submodules< / span > < / td >
< / tr >
< tr > < td class = "summary" >
< ul class = "nomargin" >
< li class = "private" > < strong class = "uidlink" > < a href = "mapnik._mapnik-module.html" onclick = "show_private();" > mapnik._mapnik< / a > < / strong > < / li >
< li > < strong class = "uidlink" > < a href = "mapnik.ogcserver-module.html" > mapnik.ogcserver< / a > < / strong > : < em class = "summary" > Mapnik OGC WMS Server.< / em >
< ul >
< li > < strong class = "uidlink" > < a href = "mapnik.ogcserver.WMS-module.html" > mapnik.ogcserver.WMS< / a > < / strong > : < em class = "summary" > Interface for registering map styles and layers for availability in
WMS Requests.< / em > < / li >
< li > < strong class = "uidlink" > < a href = "mapnik.ogcserver.cgiserver-module.html" > mapnik.ogcserver.cgiserver< / a > < / strong > : < em class = "summary" > CGI/FastCGI handler for Mapnik OGC WMS Server.< / em > < / li >
< li > < strong class = "uidlink" > < a href = "mapnik.ogcserver.common-module.html" > mapnik.ogcserver.common< / a > < / strong > : < em class = "summary" > Core OGCServer classes and functions.< / em > < / li >
< li > < strong class = "uidlink" > < a href = "mapnik.ogcserver.configparser-module.html" > mapnik.ogcserver.configparser< / a > < / strong > : < em class = "summary" > Change SafeConfigParser behavior to treat options without values as
non-existent.< / em > < / li >
< li > < strong class = "uidlink" > < a href = "mapnik.ogcserver.exceptions-module.html" > mapnik.ogcserver.exceptions< / a > < / strong > : < em class = "summary" > Custom OGCServer Exceptions< / em > < / li >
< li > < strong class = "uidlink" > < a href = "mapnik.ogcserver.modserver-module.html" > mapnik.ogcserver.modserver< / a > < / strong > : < em class = "summary" > Mod_python handler for Mapnik OGC WMS Server.< / em > < / li >
< li > < strong class = "uidlink" > < a href = "mapnik.ogcserver.wms111-module.html" > mapnik.ogcserver.wms111< / a > < / strong > : < em class = "summary" > WMS 1.1.1 compliant GetCapabilities, GetMap, GetFeatureInfo, and
Exceptions interface.< / em > < / li >
< li > < strong class = "uidlink" > < a href = "mapnik.ogcserver.wms130-module.html" > mapnik.ogcserver.wms130< / a > < / strong > : < em class = "summary" > WMS 1.3.0 compliant GetCapabilities, GetMap, GetFeatureInfo, and
Exceptions interface.< / em > < / li >
< li > < strong class = "uidlink" > < a href = "mapnik.ogcserver.wsgi-module.html" > mapnik.ogcserver.wsgi< / a > < / strong > : < em class = "summary" > WSGI application wrapper for Mapnik OGC WMS Server.< / em > < / li >
< / ul >
< / li >
2009-11-08 17:02:17 +00:00
< li class = "private" > < strong class = "uidlink" > < a href = "mapnik.paths-module.html" onclick = "show_private();" > mapnik.paths< / a > < / strong > : < em class = "summary" > Configuration paths of Mapnik fonts and input plugins
2009-03-30 05:20:00 +00:00
(autogenerated by SCons).< / em > < / li >
< / ul > < / td > < / tr >
< / table >
< br / >
<!-- ==================== CLASSES ==================== -->
< a name = "section-Classes" > < / a >
< table class = "summary" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr bgcolor = "#70b0f0" class = "table-header" >
< td align = "left" colspan = "2" class = "table-header" >
< span class = "table-header" > Classes< / span > < / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
2009-11-08 17:02:17 +00:00
< a href = "mapnik._mapnik.Color-class.html" class = "summary-name" > Color< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik.Coord-class.html" class = "summary-name" > Coord< / a > < br / >
Represents a point with two coordinates (either lon/lat or x/y).
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.DatasourceCache-class.html" class = "summary-name" > DatasourceCache< / a >
2009-03-30 05:20:00 +00:00
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik.Envelope-class.html" class = "summary-name" > Envelope< / a > < br / >
2009-11-08 17:02:17 +00:00
Represents a spatial envelope (i.e.
2009-03-30 05:20:00 +00:00
< / td >
< / tr >
2009-07-08 22:33:16 +00:00
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik.Feature-class.html" class = "summary-name" > Feature< / a >
< / td >
< / tr >
2009-03-30 05:20:00 +00:00
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
2009-11-08 17:02:17 +00:00
< a href = "mapnik._mapnik.Featureset-class.html" class = "summary-name" > Featureset< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.FontEngine-class.html" class = "summary-name" > FontEngine< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.Geometry2d-class.html" class = "summary-name" > Geometry2d< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.Image-class.html" class = "summary-name" > Image< / a > < br / >
This class represents a 32 bit RGBA image.
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.ImageView-class.html" class = "summary-name" > ImageView< / a > < br / >
A view into an image.
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.Layer-class.html" class = "summary-name" > Layer< / a > < br / >
A Mapnik map layer.
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.Layers-class.html" class = "summary-name" > Layers< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.LinePatternSymbolizer-class.html" class = "summary-name" > LinePatternSymbolizer< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.LineSymbolizer-class.html" class = "summary-name" > LineSymbolizer< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.Map-class.html" class = "summary-name" > Map< / a > < br / >
The map object.
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.Names-class.html" class = "summary-name" > Names< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.Parameter-class.html" class = "summary-name" > Parameter< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.Parameters-class.html" class = "summary-name" > Parameters< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.PointDatasource-class.html" class = "summary-name" > PointDatasource< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.PointSymbolizer-class.html" class = "summary-name" > PointSymbolizer< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.PolygonPatternSymbolizer-class.html" class = "summary-name" > PolygonPatternSymbolizer< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.PolygonSymbolizer-class.html" class = "summary-name" > PolygonSymbolizer< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.ProjTransform-class.html" class = "summary-name" > ProjTransform< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik.Projection-class.html" class = "summary-name" > Projection< / a > < br / >
Represents a map projection.
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.Properties-class.html" class = "summary-name" > Properties< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.Query-class.html" class = "summary-name" > Query< / a > < br / >
a spatial query data object
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.RasterSymbolizer-class.html" class = "summary-name" > RasterSymbolizer< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.Rule-class.html" class = "summary-name" > Rule< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.Rules-class.html" class = "summary-name" > Rules< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.ShieldSymbolizer-class.html" class = "summary-name" > ShieldSymbolizer< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.Singleton-class.html" class = "summary-name" > Singleton< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.Stroke-class.html" class = "summary-name" > Stroke< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.Style-class.html" class = "summary-name" > Style< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik.Symbolizer-class.html" class = "summary-name" > Symbolizer< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.Symbolizers-class.html" class = "summary-name" > Symbolizers< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.TextSymbolizer-class.html" class = "summary-name" > TextSymbolizer< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.ViewTransform-class.html" class = "summary-name" > ViewTransform< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.aspect_fix_mode-class.html" class = "summary-name" > aspect_fix_mode< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.label_placement-class.html" class = "summary-name" > label_placement< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.line_cap-class.html" class = "summary-name" > line_cap< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.line_join-class.html" class = "summary-name" > line_join< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.text_convert-class.html" class = "summary-name" > text_convert< / a >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< a href = "mapnik._mapnik.vertical_alignment-class.html" class = "summary-name" > vertical_alignment< / a >
2009-03-30 05:20:00 +00:00
< / td >
< / tr >
< / table >
<!-- ==================== FUNCTIONS ==================== -->
< a name = "section-Functions" > < / a >
< table class = "summary" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr bgcolor = "#70b0f0" class = "table-header" >
< td align = "left" colspan = "2" class = "table-header" >
< span class = "table-header" > Functions< / span > < / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td > < span class = "summary-sig" > < a href = "mapnik-module.html#Datasource" class = "summary-sig-name" > Datasource< / a > (< span class = "summary-sig-arg" > **keywords< / span > )< / span > < br / >
Wrapper around CreateDatasource.< / td >
< td align = "right" valign = "top" >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td > < span class = "summary-sig" > < a href = "mapnik-module.html#Shapefile" class = "summary-sig-name" > Shapefile< / a > (< span class = "summary-sig-arg" > **keywords< / span > )< / span > < br / >
Create a Shapefile Datasource.< / td >
< td align = "right" valign = "top" >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td > < span class = "summary-sig" > < a href = "mapnik-module.html#PostGIS" class = "summary-sig-name" > PostGIS< / a > (< span class = "summary-sig-arg" > **keywords< / span > )< / span > < br / >
Create a PostGIS Datasource.< / td >
< td align = "right" valign = "top" >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td > < span class = "summary-sig" > < a href = "mapnik-module.html#Raster" class = "summary-sig-name" > Raster< / a > (< span class = "summary-sig-arg" > **keywords< / span > )< / span > < br / >
Create a Raster (Tiff) Datasource.< / td >
< td align = "right" valign = "top" >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td > < span class = "summary-sig" > < a href = "mapnik-module.html#Gdal" class = "summary-sig-name" > Gdal< / a > (< span class = "summary-sig-arg" > **keywords< / span > )< / span > < br / >
Create a GDAL Raster Datasource.< / td >
< td align = "right" valign = "top" >
2009-04-01 00:47:05 +00:00
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td > < span class = "summary-sig" > < a href = "mapnik-module.html#Occi" class = "summary-sig-name" > Occi< / a > (< span class = "summary-sig-arg" > **keywords< / span > )< / span > < br / >
Create a Oracle Spatial (10g) Vector Datasource.< / td >
< td align = "right" valign = "top" >
2009-03-30 05:20:00 +00:00
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td > < span class = "summary-sig" > < a href = "mapnik-module.html#Ogr" class = "summary-sig-name" > Ogr< / a > (< span class = "summary-sig-arg" > **keywords< / span > )< / span > < br / >
Create a OGR Vector Datasource.< / td >
< td align = "right" valign = "top" >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td > < span class = "summary-sig" > < a href = "mapnik-module.html#SQLite" class = "summary-sig-name" > SQLite< / a > (< span class = "summary-sig-arg" > **keywords< / span > )< / span > < br / >
Create a SQLite Datasource.< / td >
< td align = "right" valign = "top" >
2009-04-01 00:47:05 +00:00
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td > < span class = "summary-sig" > < a href = "mapnik-module.html#Osm" class = "summary-sig-name" > Osm< / a > (< span class = "summary-sig-arg" > **keywords< / span > )< / span > < br / >
Create a Osm Datasource.< / td >
< td align = "right" valign = "top" >
2009-07-08 22:33:16 +00:00
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td > < span class = "summary-sig" > < a href = "mapnik-module.html#Kismet" class = "summary-sig-name" > Kismet< / a > (< span class = "summary-sig-arg" > **keywords< / span > )< / span > < br / >
Create a Kismet Datasource.< / td >
< td align = "right" valign = "top" >
2009-03-30 05:20:00 +00:00
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td > < span class = "summary-sig" > < a name = "mapnik_version_string" > < / a > < span class = "summary-sig-name" > mapnik_version_string< / span > ()< / span > < br / >
Return the Mapnik version as a string.< / td >
< td align = "right" valign = "top" >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
2009-11-08 17:02:17 +00:00
< td > < span class = "summary-sig" > < a name = "register_plugins" > < / a > < span class = "summary-sig-name" > register_plugins< / span > (< span class = "summary-sig-arg" > path< / span > =< span class = "summary-sig-default" > < code class = "variable-quote" > '< / code > < code class = "variable-string" > /usr/local/lib/mapnik/input< / code > < code class = "variable-quote" > '< / code > < / span > )< / span > < br / >
Register plugins located by specified path< / td >
2009-03-30 05:20:00 +00:00
< td align = "right" valign = "top" >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
2009-11-08 17:02:17 +00:00
< td > < span class = "summary-sig" > < a name = "register_fonts" > < / a > < span class = "summary-sig-name" > register_fonts< / span > (< span class = "summary-sig-arg" > path< / span > =< span class = "summary-sig-default" > < code class = "variable-quote" > '< / code > < code class = "variable-string" > /usr/local/lib/mapnik/fonts< / code > < code class = "variable-quote" > '< / code > < / span > )< / span > < br / >
Recursively register fonts using path argument as base directory< / td >
2009-03-30 05:20:00 +00:00
< td align = "right" valign = "top" >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
2009-11-08 17:02:17 +00:00
< td > < span class = "summary-sig" > < a href = "mapnik-module.html#CreateDatasource" class = "summary-sig-name" > CreateDatasource< / a > (< span class = "summary-sig-arg" > ...< / span > )< / span > < br / >
CreateDatasource( (dict)arg1) -> Datasource :< / td >
< td align = "right" valign = "top" >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td > < span class = "summary-sig" > < a href = "mapnik-module.html#Describe" class = "summary-sig-name" > Describe< / a > (< span class = "summary-sig-arg" > ...< / span > )< / span > < br / >
Describe( (Datasource)arg1) -> str :< / td >
2009-03-30 05:20:00 +00:00
< td align = "right" valign = "top" >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
2009-11-08 17:02:17 +00:00
< td > < span class = "summary-sig" > < a href = "mapnik-module.html#Filter" class = "summary-sig-name" > Filter< / a > (< span class = "summary-sig-arg" > ...< / span > )< / span > < br / >
Filter( (str)arg1) -> Filter :< / td >
2009-03-30 05:20:00 +00:00
< td align = "right" valign = "top" >
2009-07-08 22:33:16 +00:00
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > bool :< / span >
< / td > < td class = "summary" >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td > < span class = "summary-sig" > < a href = "mapnik-module.html#has_cairo" class = "summary-sig-name" > has_cairo< / a > ()< / span > < br / >
Get cairo library status< / td >
< td align = "right" valign = "top" >
2009-03-30 05:20:00 +00:00
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
2009-11-08 17:02:17 +00:00
< span class = "summary-type" > bool :< / span >
2009-03-30 05:20:00 +00:00
< / td > < td class = "summary" >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
2009-11-08 17:02:17 +00:00
< td > < span class = "summary-sig" > < a href = "mapnik-module.html#has_pycairo" class = "summary-sig-name" > has_pycairo< / a > ()< / span > < br / >
Get pycairo module status< / td >
2009-03-30 05:20:00 +00:00
< td align = "right" valign = "top" >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td > < span class = "summary-sig" > < a href = "mapnik-module.html#load_map" class = "summary-sig-name" > load_map< / a > (< span class = "summary-sig-arg" > ...< / span > )< / span > < br / >
load_map( (Map)arg1, (str)arg2 [, (bool)arg3]) -> None :< / td >
< td align = "right" valign = "top" >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td > < span class = "summary-sig" > < a href = "mapnik-module.html#load_map_from_string" class = "summary-sig-name" > load_map_from_string< / a > (< span class = "summary-sig-arg" > ...< / span > )< / span > < br / >
load_map_from_string( (Map)arg1, (str)arg2 [, (bool)arg3]) -> None :< / td >
< td align = "right" valign = "top" >
2009-11-08 17:02:17 +00:00
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > int :< / span >
< / td > < td class = "summary" >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td > < span class = "summary-sig" > < a href = "mapnik-module.html#mapnik_svn_revision" class = "summary-sig-name" > mapnik_svn_revision< / a > ()< / span > < br / >
Get the Mapnik svn revision< / td >
< td align = "right" valign = "top" >
2009-03-30 05:20:00 +00:00
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > int :< / span >
< / td > < td class = "summary" >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td > < span class = "summary-sig" > < a href = "mapnik-module.html#mapnik_version" class = "summary-sig-name" > mapnik_version< / a > ()< / span > < br / >
Get the Mapnik version number< / td >
< td align = "right" valign = "top" >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td > < span class = "summary-sig" > < a href = "mapnik-module.html#render" class = "summary-sig-name" > render< / a > (< span class = "summary-sig-arg" > ...< / span > )< / span > < br / >
render( (Map)arg1, (Image)arg2, (int)arg3, (int)arg4) -> None :< / td >
< td align = "right" valign = "top" >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td > < span class = "summary-sig" > < a href = "mapnik-module.html#render_tile_to_file" class = "summary-sig-name" > render_tile_to_file< / a > (< span class = "summary-sig-arg" > ...< / span > )< / span > < br / >
render_tile_to_file( (Map)arg1, (int)arg2, (int)arg3, (int)arg4, (int)arg5, (str)arg6, (str)arg7) -> None :< / td >
< td align = "right" valign = "top" >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td > < span class = "summary-sig" > < a href = "mapnik-module.html#render_to_file" class = "summary-sig-name" > render_to_file< / a > (< span class = "summary-sig-arg" > ...< / span > )< / span > < br / >
render_to_file( (Map)arg1, (str)arg2, (str)arg3) -> None :< / td >
< td align = "right" valign = "top" >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td > < span class = "summary-sig" > < a href = "mapnik-module.html#save_map" class = "summary-sig-name" > save_map< / a > (< span class = "summary-sig-arg" > ...< / span > )< / span > < br / >
2009-07-08 22:33:16 +00:00
save_map( (Map)arg1, (str)arg2 [, (bool)arg3]) -> None :< / td >
2009-03-30 05:20:00 +00:00
< td align = "right" valign = "top" >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
2009-11-08 17:02:17 +00:00
< td > < span class = "summary-sig" > < a href = "mapnik-module.html#save_map_string" class = "summary-sig-name" > save_map_string< / a > (< span class = "summary-sig-arg" > ...< / span > )< / span > < br / >
save_map_string( (Map)arg1 [, (bool)arg2]) -> str :< / td >
2009-03-30 05:20:00 +00:00
< td align = "right" valign = "top" >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td width = "15%" align = "right" valign = "top" class = "summary" >
< span class = "summary-type" > < / span >
< / td > < td class = "summary" >
2009-11-08 17:02:17 +00:00
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td > < span class = "summary-sig" > < a href = "mapnik-module.html#scale_denominator" class = "summary-sig-name" > scale_denominator< / a > (< span class = "summary-sig-arg" > ...< / span > )< / span > < br / >
scale_denominator( (Map)arg1, (bool)arg2) -> float :< / td >
< td align = "right" valign = "top" >
< / td >
< / tr >
< / table >
2009-03-30 05:20:00 +00:00
< / td >
< / tr >
< / table >
<!-- ==================== FUNCTION DETAILS ==================== -->
< a name = "section-FunctionDetails" > < / a >
< table class = "details" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr bgcolor = "#70b0f0" class = "table-header" >
< td align = "left" colspan = "2" class = "table-header" >
< span class = "table-header" > Function Details< / span > < / td >
< / tr >
< / table >
< a name = "Datasource" > < / a >
< div >
< table class = "details" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr > < td >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr valign = "top" > < td >
< h3 class = "epydoc" > < span class = "sig" > < span class = "sig-name" > Datasource< / span > (< span class = "sig-arg" > **keywords< / span > )< / span >
< / h3 >
< / td > < td align = "right" valign = "top"
>
< / td >
< / tr > < / table >
< pre class = "literalblock" >
Wrapper around CreateDatasource.
Create a Mapnik Datasource using a dictionary of parameters.
Keywords must include:
type='plugin_name' # e.g. type='gdal'
See the convenience factory methods of each input plugin for
details on additional required keyword arguments.
< / pre >
< dl class = "fields" >
< / dl >
< / td > < / tr > < / table >
< / div >
< a name = "Shapefile" > < / a >
< div >
< table class = "details" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr > < td >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr valign = "top" > < td >
< h3 class = "epydoc" > < span class = "sig" > < span class = "sig-name" > Shapefile< / span > (< span class = "sig-arg" > **keywords< / span > )< / span >
< / h3 >
< / td > < td align = "right" valign = "top"
>
< / td >
< / tr > < / table >
< pre class = "literalblock" >
Create a Shapefile Datasource.
Required keyword arguments:
file -- path to shapefile without extension
Optional keyword arguments:
base -- path prefix (default None)
encoding -- file encoding (default 'utf-8')
> > > from mapnik import Shapefile, Layer
> > > shp = Shapefile(base='/home/mapnik/data',file='world_borders')
> > > lyr = Layer('Shapefile Layer')
> > > lyr.datasource = shp
< / pre >
< dl class = "fields" >
< / dl >
< / td > < / tr > < / table >
< / div >
< a name = "PostGIS" > < / a >
< div >
< table class = "details" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr > < td >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr valign = "top" > < td >
< h3 class = "epydoc" > < span class = "sig" > < span class = "sig-name" > PostGIS< / span > (< span class = "sig-arg" > **keywords< / span > )< / span >
< / h3 >
< / td > < td align = "right" valign = "top"
>
< / td >
< / tr > < / table >
< pre class = "literalblock" >
Create a PostGIS Datasource.
Required keyword arguments:
dbname -- database name to connect to
table -- table name or subselect query
Optional db connection keyword arguments:
user -- database user to connect as (default: see postgres docs)
password -- password for database user (default: see postgres docs)
host -- portgres hostname (default: see postgres docs)
port -- postgres port (default: see postgres docs)
initial_size -- integer size of connection pool (default 1)
max_size -- integer max of connection pool (default 10)
Optional table-level keyword arguments:
extent -- manually specified data extent (comma delimited string, default None)
estimate_extent -- boolean, direct PostGIS to use the faster, less accurate estimate_extent() over extent() (default False)
row_limit -- integer limit of rows to return (default 0)
cursor_size -- integer size of cursor to fetch (default 0)
geometry_field -- specify geometry field (default first entry in geometry_columns)
multiple_geometries -- boolean, direct the Mapnik wkb reader to interpret as multigeometries (default False)
> > > from mapnik import PostGIS, Layer
> > > params = dict(dbname='mapnik',table='osm',user='postgres',password='gis')
> > > params['estimate_extent'] = False
> > > params['extent'] = '-20037508,-19929239,20037508,19929239'
> > > postgis = PostGIS(**params)
> > > lyr = Layer('PostGIS Layer')
> > > lyr.datasource = postgis
< / pre >
< dl class = "fields" >
< / dl >
< / td > < / tr > < / table >
< / div >
< a name = "Raster" > < / a >
< div >
< table class = "details" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr > < td >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr valign = "top" > < td >
< h3 class = "epydoc" > < span class = "sig" > < span class = "sig-name" > Raster< / span > (< span class = "sig-arg" > **keywords< / span > )< / span >
< / h3 >
< / td > < td align = "right" valign = "top"
>
< / td >
< / tr > < / table >
< pre class = "literalblock" >
Create a Raster (Tiff) Datasource.
Required keyword arguments:
file -- path to stripped or tiled tiff
lox -- lowest (min) x/longitude of tiff extent
loy -- lowest (min) y/latitude of tiff extent
hix -- highest (max) x/longitude of tiff extent
hiy -- highest (max) y/latitude of tiff extent
Hint: lox,loy,hix,hiy make a Mapnik Envelope
Optional keyword arguments:
base -- path prefix (default None)
> > > from mapnik import Raster, Layer
> > > raster = Raster(base='/home/mapnik/data',file='elevation.tif',lox=-122.8,loy=48.5,hix=-122.7,hiy=48.6)
> > > lyr = Layer('Tiff Layer')
> > > lyr.datasource = raster
< / pre >
< dl class = "fields" >
< / dl >
< / td > < / tr > < / table >
< / div >
< a name = "Gdal" > < / a >
< div >
< table class = "details" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr > < td >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr valign = "top" > < td >
< h3 class = "epydoc" > < span class = "sig" > < span class = "sig-name" > Gdal< / span > (< span class = "sig-arg" > **keywords< / span > )< / span >
< / h3 >
< / td > < td align = "right" valign = "top"
>
< / td >
< / tr > < / table >
< pre class = "literalblock" >
Create a GDAL Raster Datasource.
Required keyword arguments:
file -- path to GDAL supported dataset
Optional keyword arguments:
base -- path prefix (default None)
> > > from mapnik import Gdal, Layer
2009-11-08 17:02:17 +00:00
> > > dataset = Gdal(base='/home/mapnik/data',file='elevation.tif')
2009-03-30 05:20:00 +00:00
> > > lyr = Layer('GDAL Layer from TIFF file')
> > > lyr.datasource = dataset
2009-04-01 00:47:05 +00:00
< / pre >
< dl class = "fields" >
< / dl >
< / td > < / tr > < / table >
< / div >
< a name = "Occi" > < / a >
< div >
< table class = "details" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr > < td >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr valign = "top" > < td >
< h3 class = "epydoc" > < span class = "sig" > < span class = "sig-name" > Occi< / span > (< span class = "sig-arg" > **keywords< / span > )< / span >
< / h3 >
< / td > < td align = "right" valign = "top"
>
< / td >
< / tr > < / table >
< pre class = "literalblock" >
Create a Oracle Spatial (10g) Vector Datasource.
Required keyword arguments:
user -- database user to connect as
password -- password for database user
host -- oracle host to connect to (does not refer to SID in tsnames.ora)
table -- table name or subselect query
Optional keyword arguments:
initial_size -- integer size of connection pool (default 1)
max_size -- integer max of connection pool (default 10)
extent -- manually specified data extent (comma delimited string, default None)
estimate_extent -- boolean, direct Oracle to use the faster, less accurate estimate_extent() over extent() (default False)
encoding -- file encoding (default 'utf-8')
geometry_field -- specify geometry field (default 'GEOLOC')
use_spatial_index -- boolean, force the use of the spatial index (default True)
multiple_geometries -- boolean, direct the Mapnik wkb reader to interpret as multigeometries (default False)
> > > from mapnik import Occi, Layer
> > > params = dict(host='myoracle',user='scott',password='tiger',table='test')
> > > params['estimate_extent'] = False
> > > params['extent'] = '-20037508,-19929239,20037508,19929239'
> > > oracle = Occi(**params)
> > > lyr = Layer('Oracle Spatial Layer')
> > > lyr.datasource = oracle
2009-03-30 05:20:00 +00:00
< / pre >
< dl class = "fields" >
< / dl >
< / td > < / tr > < / table >
< / div >
< a name = "Ogr" > < / a >
< div >
< table class = "details" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr > < td >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr valign = "top" > < td >
< h3 class = "epydoc" > < span class = "sig" > < span class = "sig-name" > Ogr< / span > (< span class = "sig-arg" > **keywords< / span > )< / span >
< / h3 >
< / td > < td align = "right" valign = "top"
>
< / td >
< / tr > < / table >
< pre class = "literalblock" >
Create a OGR Vector Datasource.
Required keyword arguments:
file -- path to OGR supported dataset
layer -- layer to use within datasource
Optional keyword arguments:
base -- path prefix (default None)
encoding -- file encoding (default 'utf-8')
multiple_geometries -- boolean, direct the Mapnik wkb reader to interpret as multigeometries (default False)
> > > from mapnik import Ogr, Layer
> > > datasource = Ogr(base='/home/mapnik/data',file='rivers.geojson',layer='OGRGeoJSON')
> > > lyr = Layer('OGR Layer from GeoJSON file')
> > > lyr.datasource = datasource
< / pre >
< dl class = "fields" >
< / dl >
< / td > < / tr > < / table >
< / div >
< a name = "SQLite" > < / a >
< div >
< table class = "details" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr > < td >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr valign = "top" > < td >
< h3 class = "epydoc" > < span class = "sig" > < span class = "sig-name" > SQLite< / span > (< span class = "sig-arg" > **keywords< / span > )< / span >
< / h3 >
< / td > < td align = "right" valign = "top"
>
< / td >
< / tr > < / table >
< pre class = "literalblock" >
Create a SQLite Datasource.
Required keyword arguments:
file -- path to SQLite database file
table -- table name or subselect query
Optional keyword arguments:
base -- path prefix (default None)
encoding -- file encoding (default 'utf-8')
extent -- manually specified data extent (comma delimited string, default None)
metadata -- name of auxillary table containing record for table with xmin, ymin, xmax, ymax, and f_table_name
geometry_field -- name of geometry field (default 'the_geom')
key_field -- name of primary key field (default 'OGC_FID')
row_offset -- specify a custom integer row offset (default 0)
row_limit -- specify a custom integer row limit (default 0)
wkb_format -- specify a wkb type of 'spatialite' (default None)
multiple_geometries -- boolean, direct the Mapnik wkb reader to interpret as multigeometries (default False)
use_spatial_index -- boolean, instruct sqlite plugin to use Rtree spatial index (default True)
> > > from mapnik import SQLite, Layer
> > > sqlite = SQLite(base='/home/mapnik/data',file='osm.db',table='osm',extent='-20037508,-19929239,20037508,19929239')
> > > lyr = Layer('SQLite Layer')
> > > lyr.datasource = sqlite
2009-04-01 00:47:05 +00:00
< / pre >
< dl class = "fields" >
< / dl >
< / td > < / tr > < / table >
< / div >
< a name = "Osm" > < / a >
< div >
< table class = "details" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr > < td >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr valign = "top" > < td >
< h3 class = "epydoc" > < span class = "sig" > < span class = "sig-name" > Osm< / span > (< span class = "sig-arg" > **keywords< / span > )< / span >
< / h3 >
< / td > < td align = "right" valign = "top"
>
< / td >
< / tr > < / table >
< pre class = "literalblock" >
Create a Osm Datasource.
Required keyword arguments:
file -- path to OSM file
Optional keyword arguments:
encoding -- file encoding (default 'utf-8')
url -- url to fetch data (default None)
bbox -- data bounding box for fetching data (default None)
2009-04-12 21:37:42 +00:00
> > > from mapnik import Osm, Layer
2009-04-01 00:47:05 +00:00
> > > datasource = Osm(file='test.osm')
> > > lyr = Layer('Osm Layer')
> > > lyr.datasource = datasource
2009-07-08 22:33:16 +00:00
< / pre >
< dl class = "fields" >
< / dl >
< / td > < / tr > < / table >
< / div >
< a name = "Kismet" > < / a >
< div >
< table class = "details" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr > < td >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr valign = "top" > < td >
< h3 class = "epydoc" > < span class = "sig" > < span class = "sig-name" > Kismet< / span > (< span class = "sig-arg" > **keywords< / span > )< / span >
< / h3 >
< / td > < td align = "right" valign = "top"
>
< / td >
< / tr > < / table >
< pre class = "literalblock" >
Create a Kismet Datasource.
Required keyword arguments:
host -- kismet hostname
port -- kismet port
Optional keyword arguments:
encoding -- file encoding (default 'utf-8')
extent -- manually specified data extent (comma delimited string, default None)
> > > from mapnik import Kismet, Layer
> > > datasource = Kismet(host='localhost',port=2501,extent='-179,-85,179,85')
> > > lyr = Layer('Kismet Server Layer')
> > > lyr.datasource = datasource
2009-03-30 05:20:00 +00:00
< / pre >
< dl class = "fields" >
< / dl >
< / td > < / tr > < / table >
< / div >
< a name = "CreateDatasource" > < / a >
< div >
< table class = "details" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr > < td >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr valign = "top" > < td >
< h3 class = "epydoc" > < span class = "sig" > < span class = "sig-name" > CreateDatasource< / span > (< span class = "sig-arg" > ...< / span > )< / span >
< / h3 >
< / td > < td align = "right" valign = "top"
>
< / td >
< / tr > < / table >
< pre class = "literalblock" >
CreateDatasource( (dict)arg1) -> Datasource :
C++ signature :
boost::shared_ptr< mapnik::datasource> CreateDatasource(boost::python::dict)
< / pre >
< dl class = "fields" >
< / dl >
< / td > < / tr > < / table >
< / div >
< a name = "Describe" > < / a >
< div >
< table class = "details" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr > < td >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr valign = "top" > < td >
< h3 class = "epydoc" > < span class = "sig" > < span class = "sig-name" > Describe< / span > (< span class = "sig-arg" > ...< / span > )< / span >
< / h3 >
< / td > < td align = "right" valign = "top"
>
< / td >
< / tr > < / table >
< pre class = "literalblock" >
Describe( (Datasource)arg1) -> str :
C++ signature :
std::string Describe(boost::shared_ptr< mapnik::datasource> )
< / pre >
< dl class = "fields" >
< / dl >
< / td > < / tr > < / table >
< / div >
< a name = "Filter" > < / a >
< div >
< table class = "details" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr > < td >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr valign = "top" > < td >
< h3 class = "epydoc" > < span class = "sig" > < span class = "sig-name" > Filter< / span > (< span class = "sig-arg" > ...< / span > )< / span >
< / h3 >
< / td > < td align = "right" valign = "top"
>
< / td >
< / tr > < / table >
< pre class = "literalblock" >
Filter( (str)arg1) -> Filter :
C++ signature :
boost::shared_ptr< mapnik::filter< mapnik::feature< mapnik::geometry< mapnik::vertex< double, 2> > , boost::shared_ptr< mapnik::raster> > > > Filter(std::string)
< / pre >
< dl class = "fields" >
< / dl >
< / td > < / tr > < / table >
< / div >
2009-11-08 17:02:17 +00:00
< a name = "has_cairo" > < / a >
2009-03-30 05:20:00 +00:00
< div >
< table class = "details" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr > < td >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr valign = "top" > < td >
2009-11-08 17:02:17 +00:00
< h3 class = "epydoc" > < span class = "sig" > < span class = "sig-name" > has_cairo< / span > ()< / span >
2009-03-30 05:20:00 +00:00
< / h3 >
< / td > < td align = "right" valign = "top"
>
< / td >
< / tr > < / table >
< pre class = "literalblock" >
2009-11-08 17:02:17 +00:00
Get cairo library status
2009-03-30 05:20:00 +00:00
C++ signature :
2009-11-08 17:02:17 +00:00
bool has_cairo()
2009-03-30 05:20:00 +00:00
< / pre >
< dl class = "fields" >
2009-11-08 17:02:17 +00:00
< dt > Returns: bool :< / dt >
2009-03-30 05:20:00 +00:00
< / dl >
< / td > < / tr > < / table >
< / div >
2009-11-08 17:02:17 +00:00
< a name = "has_pycairo" > < / a >
2009-07-08 22:33:16 +00:00
< div >
< table class = "details" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr > < td >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr valign = "top" > < td >
2009-11-08 17:02:17 +00:00
< h3 class = "epydoc" > < span class = "sig" > < span class = "sig-name" > has_pycairo< / span > ()< / span >
2009-07-08 22:33:16 +00:00
< / h3 >
< / td > < td align = "right" valign = "top"
>
< / td >
< / tr > < / table >
< pre class = "literalblock" >
2009-11-08 17:02:17 +00:00
Get pycairo module status
2009-07-08 22:33:16 +00:00
C++ signature :
2009-11-08 17:02:17 +00:00
bool has_pycairo()
2009-07-08 22:33:16 +00:00
< / pre >
< dl class = "fields" >
< dt > Returns: bool :< / dt >
< / dl >
< / td > < / tr > < / table >
< / div >
2009-11-08 17:02:17 +00:00
< a name = "load_map" > < / a >
2009-03-30 05:20:00 +00:00
< div >
< table class = "details" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr > < td >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr valign = "top" > < td >
2009-11-08 17:02:17 +00:00
< h3 class = "epydoc" > < span class = "sig" > < span class = "sig-name" > load_map< / span > (< span class = "sig-arg" > ...< / span > )< / span >
2009-03-30 05:20:00 +00:00
< / h3 >
< / td > < td align = "right" valign = "top"
>
< / td >
< / tr > < / table >
< pre class = "literalblock" >
2009-11-08 17:02:17 +00:00
load_map( (Map)arg1, (str)arg2 [, (bool)arg3]) -> None :
2009-03-30 05:20:00 +00:00
C++ signature :
2009-11-08 17:02:17 +00:00
void load_map(mapnik::Map {lvalue},std::string [,bool])
2009-03-30 05:20:00 +00:00
< / pre >
< dl class = "fields" >
< / dl >
< / td > < / tr > < / table >
< / div >
2009-11-08 17:02:17 +00:00
< a name = "load_map_from_string" > < / a >
2009-03-30 05:20:00 +00:00
< div >
< table class = "details" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr > < td >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr valign = "top" > < td >
2009-11-08 17:02:17 +00:00
< h3 class = "epydoc" > < span class = "sig" > < span class = "sig-name" > load_map_from_string< / span > (< span class = "sig-arg" > ...< / span > )< / span >
2009-03-30 05:20:00 +00:00
< / h3 >
< / td > < td align = "right" valign = "top"
>
< / td >
< / tr > < / table >
< pre class = "literalblock" >
2009-11-08 17:02:17 +00:00
load_map_from_string( (Map)arg1, (str)arg2 [, (bool)arg3]) -> None :
2009-03-30 05:20:00 +00:00
C++ signature :
2009-11-08 17:02:17 +00:00
void load_map_from_string(mapnik::Map {lvalue},std::string [,bool])
2009-03-30 05:20:00 +00:00
< / pre >
< dl class = "fields" >
< / dl >
< / td > < / tr > < / table >
< / div >
2009-11-08 17:02:17 +00:00
< a name = "mapnik_svn_revision" > < / a >
2009-03-30 05:20:00 +00:00
< div >
< table class = "details" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr > < td >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr valign = "top" > < td >
2009-11-08 17:02:17 +00:00
< h3 class = "epydoc" > < span class = "sig" > < span class = "sig-name" > mapnik_svn_revision< / span > ()< / span >
2009-03-30 05:20:00 +00:00
< / h3 >
< / td > < td align = "right" valign = "top"
>
< / td >
< / tr > < / table >
< pre class = "literalblock" >
2009-11-08 17:02:17 +00:00
Get the Mapnik svn revision
2009-03-30 05:20:00 +00:00
C++ signature :
2009-11-08 17:02:17 +00:00
unsigned int mapnik_svn_revision()
2009-03-30 05:20:00 +00:00
< / pre >
< dl class = "fields" >
2009-11-08 17:02:17 +00:00
< dt > Returns: int :< / dt >
2009-03-30 05:20:00 +00:00
< / dl >
< / td > < / tr > < / table >
< / div >
< a name = "mapnik_version" > < / a >
< div >
< table class = "details" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr > < td >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr valign = "top" > < td >
< h3 class = "epydoc" > < span class = "sig" > < span class = "sig-name" > mapnik_version< / span > ()< / span >
< / h3 >
< / td > < td align = "right" valign = "top"
>
< / td >
< / tr > < / table >
< pre class = "literalblock" >
Get the Mapnik version number
C++ signature :
unsigned int mapnik_version()
< / pre >
< dl class = "fields" >
< dt > Returns: int :< / dt >
< / dl >
< / td > < / tr > < / table >
< / div >
< a name = "render" > < / a >
< div >
< table class = "details" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr > < td >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr valign = "top" > < td >
< h3 class = "epydoc" > < span class = "sig" > < span class = "sig-name" > render< / span > (< span class = "sig-arg" > ...< / span > )< / span >
< / h3 >
< / td > < td align = "right" valign = "top"
>
< / td >
< / tr > < / table >
< pre class = "literalblock" >
render( (Map)arg1, (Image)arg2, (int)arg3, (int)arg4) -> None :
Render Map to an AGG Image32 using offsets
Usage:
> > > from mapnik import Map, Image, render, load_map
> > > m = Map(256,256)
> > > load_map(m,'mapfile.xml')
> > > im = Image(m.width,m.height)
> > > render(m,im,1,1)
C++ signature :
void render(mapnik::Map,mapnik::Image32 {lvalue},unsigned int,unsigned int)
render( (Map)arg1, (Image)arg2) -> None :
Render Map to an AGG Image32
Usage:
> > > from mapnik import Map, Image, render, load_map
> > > m = Map(256,256)
> > > load_map(m,'mapfile.xml')
> > > im = Image(m.width,m.height)
> > > render(m,im)
C++ signature :
void render(mapnik::Map,mapnik::Image32 {lvalue})
2009-11-08 17:02:17 +00:00
render( (Map)arg1, (object)arg2, (int)arg3, (int)arg4) -> None :
Render Map to Cairo Surface using offsets
Usage:
> > > from mapnik import Map, render, load_map
> > > from cairo import SVGSurface
> > > m = Map(256,256)
> > > load_map(m,'mapfile.xml')
> > > surface = SVGSurface('image.svg', m.width, m.height)
> > > render(m,surface,1,1)
C++ signature :
void render(mapnik::Map,PycairoSurface*,unsigned int,unsigned int)
render( (Map)arg1, (object)arg2) -> None :
Render Map to Cairo Surface
Usage:
> > > from mapnik import Map, render, load_map
> > > from cairo import SVGSurface
> > > m = Map(256,256)
> > > load_map(m,'mapfile.xml')
> > > surface = SVGSurface('image.svg', m.width, m.height)
> > > render(m,surface)
C++ signature :
void render(mapnik::Map,PycairoSurface*)
render( (Map)arg1, (object)arg2, (int)arg3, (int)arg4) -> None :
Render Map to Cairo Context using offsets
Usage:
> > > from mapnik import Map, render, load_map
> > > from cairo import SVGSurface, Context
> > > surface = SVGSurface('image.svg', m.width, m.height)
> > > ctx = Context(surface)
> > > load_map(m,'mapfile.xml')
> > > render(m,context,1,1)
C++ signature :
void render(mapnik::Map,PycairoContext*,unsigned int,unsigned int)
render( (Map)arg1, (object)arg2) -> None :
Render Map to Cairo Context
Usage:
> > > from mapnik import Map, render, load_map
> > > from cairo import SVGSurface, Context
> > > surface = SVGSurface('image.svg', m.width, m.height)
> > > ctx = Context(surface)
> > > load_map(m,'mapfile.xml')
> > > render(m,context)
C++ signature :
void render(mapnik::Map,PycairoContext*)
2009-03-30 05:20:00 +00:00
< / pre >
< dl class = "fields" >
< / dl >
< / td > < / tr > < / table >
< / div >
< a name = "render_tile_to_file" > < / a >
< div >
< table class = "details" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr > < td >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr valign = "top" > < td >
< h3 class = "epydoc" > < span class = "sig" > < span class = "sig-name" > render_tile_to_file< / span > (< span class = "sig-arg" > ...< / span > )< / span >
< / h3 >
< / td > < td align = "right" valign = "top"
>
< / td >
< / tr > < / table >
< pre class = "literalblock" >
render_tile_to_file( (Map)arg1, (int)arg2, (int)arg3, (int)arg4, (int)arg5, (str)arg6, (str)arg7) -> None :
TODO
C++ signature :
void render_tile_to_file(mapnik::Map,unsigned int,unsigned int,unsigned int,unsigned int,std::string,std::string)
< / pre >
< dl class = "fields" >
< / dl >
< / td > < / tr > < / table >
< / div >
< a name = "render_to_file" > < / a >
< div >
< table class = "details" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr > < td >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr valign = "top" > < td >
< h3 class = "epydoc" > < span class = "sig" > < span class = "sig-name" > render_to_file< / span > (< span class = "sig-arg" > ...< / span > )< / span >
< / h3 >
< / td > < td align = "right" valign = "top"
>
< / td >
< / tr > < / table >
< pre class = "literalblock" >
render_to_file( (Map)arg1, (str)arg2, (str)arg3) -> None :
2009-04-12 21:37:42 +00:00
Render Map to file using explicit image type.
2009-03-30 05:20:00 +00:00
Usage:
> > > from mapnik import Map, render_to_file, load_map
> > > m = Map(256,256)
> > > load_map(m,'mapfile.xml')
> > > render_to_file(m,'image32bit.png','png')
2009-07-08 22:33:16 +00:00
8 bit (paletted) PNG can be requested with 'png256':
2009-04-12 21:37:42 +00:00
> > > render_to_file(m,'8bit_image.png','png256')
2009-07-08 22:33:16 +00:00
JPEG quality can be controlled by adding a suffix to
'jpeg' between 0 and 100 (default is 85):
2009-04-12 21:37:42 +00:00
> > > render_to_file(m,'top_quality.jpeg','jpeg100')
> > > render_to_file(m,'medium_quality.jpeg','jpeg50')
2009-03-30 05:20:00 +00:00
C++ signature :
void render_to_file(mapnik::Map,std::string,std::string)
render_to_file( (Map)arg1, (str)arg2) -> None :
Render Map to file (type taken from file extension)
Usage:
> > > from mapnik import Map, render_to_file, load_map
> > > m = Map(256,256)
> > > render_to_file(m,'image.jpeg')
C++ signature :
void render_to_file(mapnik::Map,std::string)
< / pre >
< dl class = "fields" >
< / dl >
< / td > < / tr > < / table >
< / div >
< a name = "save_map" > < / a >
< div >
< table class = "details" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr > < td >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr valign = "top" > < td >
< h3 class = "epydoc" > < span class = "sig" > < span class = "sig-name" > save_map< / span > (< span class = "sig-arg" > ...< / span > )< / span >
< / h3 >
< / td > < td align = "right" valign = "top"
>
< / td >
< / tr > < / table >
< pre class = "literalblock" >
2009-07-08 22:33:16 +00:00
save_map( (Map)arg1, (str)arg2 [, (bool)arg3]) -> None :
2009-03-30 05:20:00 +00:00
C++ signature :
2009-07-08 22:33:16 +00:00
void save_map(mapnik::Map,std::string [,bool])
2009-03-30 05:20:00 +00:00
2009-11-08 17:02:17 +00:00
< / pre >
< dl class = "fields" >
< / dl >
< / td > < / tr > < / table >
< / div >
< a name = "save_map_string" > < / a >
< div >
< table class = "details" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr > < td >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr valign = "top" > < td >
< h3 class = "epydoc" > < span class = "sig" > < span class = "sig-name" > save_map_string< / span > (< span class = "sig-arg" > ...< / span > )< / span >
< / h3 >
< / td > < td align = "right" valign = "top"
>
< / td >
< / tr > < / table >
< pre class = "literalblock" >
save_map_string( (Map)arg1 [, (bool)arg2]) -> str :
C++ signature :
std::string save_map_string(mapnik::Map [,bool])
2009-03-30 05:20:00 +00:00
< / pre >
< dl class = "fields" >
< / dl >
< / td > < / tr > < / table >
< / div >
< a name = "scale_denominator" > < / a >
< div >
< table class = "details" border = "1" cellpadding = "3"
cellspacing="0" width="100%" bgcolor="white">
< tr > < td >
< table width = "100%" cellpadding = "0" cellspacing = "0" border = "0" >
< tr valign = "top" > < td >
< h3 class = "epydoc" > < span class = "sig" > < span class = "sig-name" > scale_denominator< / span > (< span class = "sig-arg" > ...< / span > )< / span >
< / h3 >
< / td > < td align = "right" valign = "top"
>
< / td >
< / tr > < / table >
< pre class = "literalblock" >
scale_denominator( (Map)arg1, (bool)arg2) -> float :
Return the Map Scale Denominator.
Also available as Map.scale_denominator()
Usage:
> > > from mapnik import Map, Projection, scale_denominator, load_map
> > > m = Map(256,256)
> > > load_map(m,'mapfile.xml')
> > > scale_denominator(m,Projection(m.srs).geographic)
C++ signature :
double scale_denominator(mapnik::Map,bool)
< / pre >
< dl class = "fields" >
< / dl >
< / td > < / tr > < / table >
< / div >
< br / >
<!-- ==================== NAVIGATION BAR ==================== -->
< table class = "navbar" border = "0" width = "100%" cellpadding = "0"
bgcolor="#a0c0ff" cellspacing="0">
< tr valign = "middle" >
<!-- Home link -->
< th bgcolor = "#70b0f0" class = "navbar-select"
> Home < / th >
<!-- Tree link -->
< th > < a
href="module-tree.html">Trees< / a > < / th >
<!-- Index link -->
< th > < a
href="identifier-index.html">Indices< / a > < / th >
<!-- Help link -->
< th > < a
href="help.html">Help< / a > < / th >
<!-- Project homepage -->
< th class = "navbar" align = "right" width = "100%" >
< table border = "0" cellpadding = "0" cellspacing = "0" >
< tr > < th class = "navbar" align = "center"
>< a class = "navbar" target = "_top" href = "http://mapnik.org" > mapnik< / a > < / th >
< / tr > < / table > < / th >
< / tr >
< / table >
< table border = "0" cellpadding = "0" cellspacing = "0" width = "100%%" >
< tr >
< td align = "left" class = "footer" >
2009-11-08 17:02:17 +00:00
Generated by Epydoc 3.0.1 on Sun Nov 8 09:00:49 2009
2009-03-30 05:20:00 +00:00
< / td >
< td align = "right" class = "footer" >
< a target = "mainFrame" href = "http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net< / a >
< / td >
< / tr >
< / table >
< script type = "text/javascript" >
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
< / script >
< / body >
< / html >
