sij/mapnik
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
mapnik/docs/api_docs/python/mapnik-module.html
Dane Springmeyer 33908e616c update python api docs
2010-01-11 00:15:30 +00:00

1900 lines
63 KiB
HTML
Raw Blame History

<?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"
>&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;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:
&gt;&gt;&gt; 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).
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.
3) All available input plugins and TrueType fonts are automatically registered.
4) Boost Python metaclass injectors are used in the '__init__.py' to extend several
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>
<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
(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">&nbsp;</span>
</td><td class="summary">
<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">&nbsp;</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">&nbsp;</span>
</td><td class="summary">
<a href="mapnik._mapnik.DatasourceCache-class.html" class="summary-name">DatasourceCache</a>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="mapnik.Envelope-class.html" class="summary-name">Envelope</a><br />
Represents a spatial envelope (i.e.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="mapnik.Feature-class.html" class="summary-name">Feature</a>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</span>
</td><td class="summary">
<a href="mapnik._mapnik.vertical_alignment-class.html" class="summary-name">vertical_alignment</a>
</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</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">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</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">&nbsp;</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">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</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">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</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">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</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">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</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#CreateDatasource" class="summary-sig-name">CreateDatasource</a>(<span class="summary-sig-arg">...</span>)</span><br />
CreateDatasource( (dict)arg1) -&gt; 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">&nbsp;</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) -&gt; str :</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">&nbsp;</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#Filter" class="summary-sig-name">Filter</a>(<span class="summary-sig-arg">...</span>)</span><br />
Filter( (str)arg1) -&gt; Filter :</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">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">
</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_pycairo" class="summary-sig-name">has_pycairo</a>()</span><br />
Get pycairo module status</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">&nbsp;</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]) -&gt; 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">&nbsp;</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 [, (str)arg4]]) -&gt; 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">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">
</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">&nbsp;</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) -&gt; 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">&nbsp;</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) -&gt; 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">&nbsp;</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) -&gt; 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">&nbsp;</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 />
save_map( (Map)arg1, (str)arg2 [, (bool)arg3]) -&gt; 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">&nbsp;</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_to_string" class="summary-sig-name">save_map_to_string</a>(<span class="summary-sig-arg">...</span>)</span><br />
save_map_to_string( (Map)arg1 [, (bool)arg2]) -&gt; str :</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">&nbsp;</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#scale_denominator" class="summary-sig-name">scale_denominator</a>(<span class="summary-sig-arg">...</span>)</span><br />
scale_denominator( (Map)arg1, (bool)arg2) -&gt; float :</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</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"
>&nbsp;
</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"
>&nbsp;
</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')
&gt;&gt;&gt; from mapnik import Shapefile, Layer
&gt;&gt;&gt; shp = Shapefile(base='/home/mapnik/data',file='world_borders')
&gt;&gt;&gt; lyr = Layer('Shapefile Layer')
&gt;&gt;&gt; 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"
>&nbsp;
</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
*Note: if using subselects for the 'table' value consider also
passing the 'geometry_field' and 'srid' and 'extent_from_subquery'
options and/or specifying the 'geometry_table' option.
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)
persist_connection -- keep connection open (default: True)
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)
extent_from_subquery -- boolean, direct Mapnik to query Postgis for the extent of the raw 'table' value (default: uses 'geometry_table')
geometry_table -- specify geometry table to use to look up metadata (default: automatically parsed from 'table' value)
geometry_field -- specify geometry field to use (default: first entry in geometry_columns)
srid -- specify srid to use (default: auto-detected from geometry_field)
row_limit -- integer limit of rows to return (default: 0)
cursor_size -- integer size of binary cursor to use (default: 0, no binary cursor is used)
multiple_geometries -- boolean, direct the Mapnik wkb reader to interpret as multigeometries (default False)
&gt;&gt;&gt; from mapnik import PostGIS, Layer
&gt;&gt;&gt; params = dict(dbname='mapnik',table='osm',user='postgres',password='gis')
&gt;&gt;&gt; params['estimate_extent'] = False
&gt;&gt;&gt; params['extent'] = '-20037508,-19929239,20037508,19929239'
&gt;&gt;&gt; postgis = PostGIS(**params)
&gt;&gt;&gt; lyr = Layer('PostGIS Layer')
&gt;&gt;&gt; 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"
>&nbsp;
</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)
&gt;&gt;&gt; from mapnik import Raster, Layer
&gt;&gt;&gt; raster = Raster(base='/home/mapnik/data',file='elevation.tif',lox=-122.8,loy=48.5,hix=-122.7,hiy=48.6)
&gt;&gt;&gt; lyr = Layer('Tiff Layer')
&gt;&gt;&gt; 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"
>&nbsp;
</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)
shared -- boolean, open GdalDataset in shared mode (default: False)
&gt;&gt;&gt; from mapnik import Gdal, Layer
&gt;&gt;&gt; dataset = Gdal(base='/home/mapnik/data',file='elevation.tif')
&gt;&gt;&gt; lyr = Layer('GDAL Layer from TIFF file')
&gt;&gt;&gt; lyr.datasource = dataset
</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"
>&nbsp;
</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)
&gt;&gt;&gt; from mapnik import Occi, Layer
&gt;&gt;&gt; params = dict(host='myoracle',user='scott',password='tiger',table='test')
&gt;&gt;&gt; params['estimate_extent'] = False
&gt;&gt;&gt; params['extent'] = '-20037508,-19929239,20037508,19929239'
&gt;&gt;&gt; oracle = Occi(**params)
&gt;&gt;&gt; lyr = Layer('Oracle Spatial Layer')
&gt;&gt;&gt; lyr.datasource = oracle
</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"
>&nbsp;
</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)
&gt;&gt;&gt; from mapnik import Ogr, Layer
&gt;&gt;&gt; datasource = Ogr(base='/home/mapnik/data',file='rivers.geojson',layer='OGRGeoJSON')
&gt;&gt;&gt; lyr = Layer('OGR Layer from GeoJSON file')
&gt;&gt;&gt; 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"
>&nbsp;
</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)
&gt;&gt;&gt; from mapnik import SQLite, Layer
&gt;&gt;&gt; sqlite = SQLite(base='/home/mapnik/data',file='osm.db',table='osm',extent='-20037508,-19929239,20037508,19929239')
&gt;&gt;&gt; lyr = Layer('SQLite Layer')
&gt;&gt;&gt; lyr.datasource = sqlite
</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"
>&nbsp;
</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)
&gt;&gt;&gt; from mapnik import Osm, Layer
&gt;&gt;&gt; datasource = Osm(file='test.osm')
&gt;&gt;&gt; lyr = Layer('Osm Layer')
&gt;&gt;&gt; lyr.datasource = datasource
</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"
>&nbsp;
</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)
&gt;&gt;&gt; from mapnik import Kismet, Layer
&gt;&gt;&gt; datasource = Kismet(host='localhost',port=2501,extent='-179,-85,179,85')
&gt;&gt;&gt; lyr = Layer('Kismet Server Layer')
&gt;&gt;&gt; lyr.datasource = datasource
</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"
>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
CreateDatasource( (dict)arg1) -&gt; Datasource :
C++ signature :
boost::shared_ptr&lt;mapnik::datasource&gt; 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"
>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
Describe( (Datasource)arg1) -&gt; str :
C++ signature :
std::string Describe(boost::shared_ptr&lt;mapnik::datasource&gt;)
</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"
>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
Filter( (str)arg1) -&gt; Filter :
C++ signature :
boost::shared_ptr&lt;mapnik::filter&lt;mapnik::feature&lt;mapnik::geometry&lt;mapnik::vertex&lt;double, 2&gt; &gt;, boost::shared_ptr&lt;mapnik::raster&gt; &gt; &gt; &gt; Filter(std::string)
</pre>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="has_cairo"></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">has_cairo</span>()</span>
</h3>
</td><td align="right" valign="top"
>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
Get cairo library status
C++ signature :
bool has_cairo()
</pre>
<dl class="fields">
<dt>Returns: bool :</dt>
</dl>
</td></tr></table>
</div>
<a name="has_pycairo"></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">has_pycairo</span>()</span>
</h3>
</td><td align="right" valign="top"
>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
Get pycairo module status
C++ signature :
bool has_pycairo()
</pre>
<dl class="fields">
<dt>Returns: bool :</dt>
</dl>
</td></tr></table>
</div>
<a name="load_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">load_map</span>(<span class="sig-arg">...</span>)</span>
</h3>
</td><td align="right" valign="top"
>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
load_map( (Map)arg1, (str)arg2 [, (bool)arg3]) -&gt; None :
C++ signature :
void load_map(mapnik::Map {lvalue},std::string [,bool])
</pre>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="load_map_from_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">load_map_from_string</span>(<span class="sig-arg">...</span>)</span>
</h3>
</td><td align="right" valign="top"
>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
load_map_from_string( (Map)arg1, (str)arg2 [, (bool)arg3 [, (str)arg4]]) -&gt; None :
C++ signature :
void load_map_from_string(mapnik::Map {lvalue},std::string [,bool [,std::string]])
</pre>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="mapnik_svn_revision"></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_svn_revision</span>()</span>
</h3>
</td><td align="right" valign="top"
>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
Get the Mapnik svn revision
C++ signature :
unsigned int mapnik_svn_revision()
</pre>
<dl class="fields">
<dt>Returns: int :</dt>
</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"
>&nbsp;
</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"
>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
render( (Map)arg1, (Image)arg2, (int)arg3, (int)arg4) -&gt; None :
Render Map to an AGG Image32 using offsets
Usage:
&gt;&gt;&gt; from mapnik import Map, Image, render, load_map
&gt;&gt;&gt; m = Map(256,256)
&gt;&gt;&gt; load_map(m,'mapfile.xml')
&gt;&gt;&gt; im = Image(m.width,m.height)
&gt;&gt;&gt; render(m,im,1,1)
C++ signature :
void render(mapnik::Map,mapnik::Image32 {lvalue},unsigned int,unsigned int)
render( (Map)arg1, (Image)arg2) -&gt; None :
Render Map to an AGG Image32
Usage:
&gt;&gt;&gt; from mapnik import Map, Image, render, load_map
&gt;&gt;&gt; m = Map(256,256)
&gt;&gt;&gt; load_map(m,'mapfile.xml')
&gt;&gt;&gt; im = Image(m.width,m.height)
&gt;&gt;&gt; render(m,im)
C++ signature :
void render(mapnik::Map,mapnik::Image32 {lvalue})
render( (Map)arg1, (object)arg2, (int)arg3, (int)arg4) -&gt; None :
Render Map to Cairo Surface using offsets
Usage:
&gt;&gt;&gt; from mapnik import Map, render, load_map
&gt;&gt;&gt; from cairo import SVGSurface
&gt;&gt;&gt; m = Map(256,256)
&gt;&gt;&gt; load_map(m,'mapfile.xml')
&gt;&gt;&gt; surface = SVGSurface('image.svg', m.width, m.height)
&gt;&gt;&gt; render(m,surface,1,1)
C++ signature :
void render(mapnik::Map,PycairoSurface*,unsigned int,unsigned int)
render( (Map)arg1, (object)arg2) -&gt; None :
Render Map to Cairo Surface
Usage:
&gt;&gt;&gt; from mapnik import Map, render, load_map
&gt;&gt;&gt; from cairo import SVGSurface
&gt;&gt;&gt; m = Map(256,256)
&gt;&gt;&gt; load_map(m,'mapfile.xml')
&gt;&gt;&gt; surface = SVGSurface('image.svg', m.width, m.height)
&gt;&gt;&gt; render(m,surface)
C++ signature :
void render(mapnik::Map,PycairoSurface*)
render( (Map)arg1, (object)arg2, (int)arg3, (int)arg4) -&gt; None :
Render Map to Cairo Context using offsets
Usage:
&gt;&gt;&gt; from mapnik import Map, render, load_map
&gt;&gt;&gt; from cairo import SVGSurface, Context
&gt;&gt;&gt; surface = SVGSurface('image.svg', m.width, m.height)
&gt;&gt;&gt; ctx = Context(surface)
&gt;&gt;&gt; load_map(m,'mapfile.xml')
&gt;&gt;&gt; render(m,context,1,1)
C++ signature :
void render(mapnik::Map,PycairoContext*,unsigned int,unsigned int)
render( (Map)arg1, (object)arg2) -&gt; None :
Render Map to Cairo Context
Usage:
&gt;&gt;&gt; from mapnik import Map, render, load_map
&gt;&gt;&gt; from cairo import SVGSurface, Context
&gt;&gt;&gt; surface = SVGSurface('image.svg', m.width, m.height)
&gt;&gt;&gt; ctx = Context(surface)
&gt;&gt;&gt; load_map(m,'mapfile.xml')
&gt;&gt;&gt; render(m,context)
C++ signature :
void render(mapnik::Map,PycairoContext*)
</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"
>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
render_tile_to_file( (Map)arg1, (int)arg2, (int)arg3, (int)arg4, (int)arg5, (str)arg6, (str)arg7) -&gt; 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"
>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
render_to_file( (Map)arg1, (str)arg2, (str)arg3) -&gt; None :
Render Map to file using explicit image type.
Usage:
&gt;&gt;&gt; from mapnik import Map, render_to_file, load_map
&gt;&gt;&gt; m = Map(256,256)
&gt;&gt;&gt; load_map(m,'mapfile.xml')
&gt;&gt;&gt; render_to_file(m,'image32bit.png','png')
8 bit (paletted) PNG can be requested with 'png256':
&gt;&gt;&gt; render_to_file(m,'8bit_image.png','png256')
JPEG quality can be controlled by adding a suffix to
'jpeg' between 0 and 100 (default is 85):
&gt;&gt;&gt; render_to_file(m,'top_quality.jpeg','jpeg100')
&gt;&gt;&gt; render_to_file(m,'medium_quality.jpeg','jpeg50')
C++ signature :
void render_to_file(mapnik::Map,std::string,std::string)
render_to_file( (Map)arg1, (str)arg2) -&gt; None :
Render Map to file (type taken from file extension)
Usage:
&gt;&gt;&gt; from mapnik import Map, render_to_file, load_map
&gt;&gt;&gt; m = Map(256,256)
&gt;&gt;&gt; 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"
>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
save_map( (Map)arg1, (str)arg2 [, (bool)arg3]) -&gt; None :
C++ signature :
void save_map(mapnik::Map,std::string [,bool])
</pre>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="save_map_to_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_to_string</span>(<span class="sig-arg">...</span>)</span>
</h3>
</td><td align="right" valign="top"
>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
save_map_to_string( (Map)arg1 [, (bool)arg2]) -&gt; str :
C++ signature :
std::string save_map_to_string(mapnik::Map [,bool])
</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"
>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
scale_denominator( (Map)arg1, (bool)arg2) -&gt; float :
Return the Map Scale Denominator.
Also available as Map.scale_denominator()
Usage:
&gt;&gt;&gt; from mapnik import Map, Projection, scale_denominator, load_map
&gt;&gt;&gt; m = Map(256,256)
&gt;&gt;&gt; load_map(m,'mapfile.xml')
&gt;&gt;&gt; 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"
>&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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">
Generated by Epydoc 3.0.1 on Sun Jan 10 16:14:09 2010
</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>
Reference in a new issue View git blame Copy permalink