sij/mapnik
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
mapnik/docs/api_docs/python/mapnik._mapnik-module.html

1291 lines
40 KiB
HTML
Raw Normal View History

replaced 'epydocs' folder with 'api_docs/python' using revised api docstrings and custom css with epydoc
2009-03-30 07:20:00 +02: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._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>&nbsp;&nbsp;&nbsp;<a
href="mapnik-module.html">Home</a>&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">
<a href="mapnik-module.html">Package&nbsp;mapnik</a> ::
Module&nbsp;_mapnik
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
</table>
</td>
</tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module _mapnik</h1><p class="nomargin-top"></p>
<!-- ==================== 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._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._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._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._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>
update python api docs and toch up formatting of __init__.py
2009-11-08 18:02:17 +01:00
<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>
refresh python api docs
2009-04-01 02:47:05 +02:00
<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>
replaced 'epydocs' folder with 'api_docs/python' using revised api docstrings and custom css with epydoc
2009-03-30 07:20:00 +02:00
</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._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._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._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">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="mapnik._mapnik-module.html#forward_" class="summary-sig-name">forward_</a>(<span class="summary-sig-arg">...</span>)</span><br />
forward_( (Coord)arg1, (Projection)arg2) -&gt; Coord :</td>
<td align="right" valign="top">
update python api docs via epydoc
2009-07-09 00:33:16 +02: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._mapnik-module.html#has_cairo" class="summary-sig-name">has_cairo</a>()</span><br />
Get cairo library status</td>
<td align="right" valign="top">
update python api docs and toch up formatting of __init__.py
2009-11-08 18:02:17 +01: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._mapnik-module.html#has_pycairo" class="summary-sig-name">has_pycairo</a>()</span><br />
Get pycairo module status</td>
<td align="right" valign="top">
replaced 'epydocs' folder with 'api_docs/python' using revised api docstrings and custom css with epydoc
2009-03-30 07:20:00 +02:00
</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._mapnik-module.html#inverse_" class="summary-sig-name">inverse_</a>(<span class="summary-sig-arg">...</span>)</span><br />
inverse_( (Coord)arg1, (Projection)arg2) -&gt; Coord :</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._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._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]) -&gt; None :</td>
<td align="right" valign="top">
update python api docs and toch up formatting of __init__.py
2009-11-08 18:02:17 +01: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._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">
replaced 'epydocs' folder with 'api_docs/python' using revised api docstrings and custom css with epydoc
2009-03-30 07:20:00 +02: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._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._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._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._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._mapnik-module.html#save_map" class="summary-sig-name">save_map</a>(<span class="summary-sig-arg">...</span>)</span><br />
update python api docs via epydoc
2009-07-09 00:33:16 +02:00
save_map( (Map)arg1, (str)arg2 [, (bool)arg3]) -&gt; None :</td>
replaced 'epydocs' folder with 'api_docs/python' using revised api docstrings and custom css with epydoc
2009-03-30 07:20:00 +02:00
<td align="right" valign="top">
update python api docs and toch up formatting of __init__.py
2009-11-08 18:02:17 +01:00
</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._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]) -&gt; str :</td>
<td align="right" valign="top">
replaced 'epydocs' folder with 'api_docs/python' using revised api docstrings and custom css with epydoc
2009-03-30 07:20:00 +02:00
</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._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="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="forward_"></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">forward_</span>(<span class="sig-arg">...</span>)</span>
</h3>
</td><td align="right" valign="top"
>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
forward_( (Coord)arg1, (Projection)arg2) -&gt; Coord :
C++ signature :
mapnik::coord&lt;double, 2&gt; forward_(mapnik::coord&lt;double, 2&gt;,mapnik::projection)
forward_( (Envelope)arg1, (Projection)arg2) -&gt; Envelope :
C++ signature :
mapnik::Envelope&lt;double&gt; forward_(mapnik::Envelope&lt;double&gt;,mapnik::projection)
</pre>
<dl class="fields">
</dl>
</td></tr></table>
</div>
update python api docs via epydoc
2009-07-09 00:33:16 +02:00
<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()
update python api docs and toch up formatting of __init__.py
2009-11-08 18:02:17 +01:00
</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()
update python api docs via epydoc
2009-07-09 00:33:16 +02:00
</pre>
<dl class="fields">
<dt>Returns: bool :</dt>
</dl>
</td></tr></table>
</div>
replaced 'epydocs' folder with 'api_docs/python' using revised api docstrings and custom css with epydoc
2009-03-30 07:20:00 +02:00
<a name="inverse_"></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">inverse_</span>(<span class="sig-arg">...</span>)</span>
</h3>
</td><td align="right" valign="top"
>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
inverse_( (Coord)arg1, (Projection)arg2) -&gt; Coord :
C++ signature :
mapnik::coord&lt;double, 2&gt; inverse_(mapnik::coord&lt;double, 2&gt;,mapnik::projection)
inverse_( (Envelope)arg1, (Projection)arg2) -&gt; Envelope :
C++ signature :
mapnik::Envelope&lt;double&gt; inverse_(mapnik::Envelope&lt;double&gt;,mapnik::projection)
</pre>
<dl class="fields">
</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]) -&gt; None :
C++ signature :
void load_map_from_string(mapnik::Map {lvalue},std::string [,bool])
</pre>
<dl class="fields">
</dl>
</td></tr></table>
</div>
update python api docs and toch up formatting of __init__.py
2009-11-08 18:02:17 +01:00
<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>
replaced 'epydocs' folder with 'api_docs/python' using revised api docstrings and custom css with epydoc
2009-03-30 07:20:00 +02:00
<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})
update python api docs and toch up formatting of __init__.py
2009-11-08 18:02:17 +01:00
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*)
replaced 'epydocs' folder with 'api_docs/python' using revised api docstrings and custom css with epydoc
2009-03-30 07:20:00 +02: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"
>&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 :
+ update python api docs
2009-04-12 23:37:42 +02:00
Render Map to file using explicit image type.
replaced 'epydocs' folder with 'api_docs/python' using revised api docstrings and custom css with epydoc
2009-03-30 07:20:00 +02:00
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')
update python api docs via epydoc
2009-07-09 00:33:16 +02:00
8 bit (paletted) PNG can be requested with 'png256':
+ update python api docs
2009-04-12 23:37:42 +02:00
&gt;&gt;&gt; render_to_file(m,'8bit_image.png','png256')
update python api docs via epydoc
2009-07-09 00:33:16 +02:00
JPEG quality can be controlled by adding a suffix to
'jpeg' between 0 and 100 (default is 85):
+ update python api docs
2009-04-12 23:37:42 +02:00
&gt;&gt;&gt; render_to_file(m,'top_quality.jpeg','jpeg100')
&gt;&gt;&gt; render_to_file(m,'medium_quality.jpeg','jpeg50')
replaced 'epydocs' folder with 'api_docs/python' using revised api docstrings and custom css with epydoc
2009-03-30 07:20:00 +02:00
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">
update python api docs via epydoc
2009-07-09 00:33:16 +02:00
save_map( (Map)arg1, (str)arg2 [, (bool)arg3]) -&gt; None :
replaced 'epydocs' folder with 'api_docs/python' using revised api docstrings and custom css with epydoc
2009-03-30 07:20:00 +02:00
C++ signature :
update python api docs via epydoc
2009-07-09 00:33:16 +02:00
void save_map(mapnik::Map,std::string [,bool])
replaced 'epydocs' folder with 'api_docs/python' using revised api docstrings and custom css with epydoc
2009-03-30 07:20:00 +02:00
update python api docs and toch up formatting of __init__.py
2009-11-08 18:02:17 +01: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"
>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
save_map_string( (Map)arg1 [, (bool)arg2]) -&gt; str :
C++ signature :
std::string save_map_string(mapnik::Map [,bool])
replaced 'epydocs' folder with 'api_docs/python' using revised api docstrings and custom css with epydoc
2009-03-30 07:20:00 +02: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"
>&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>&nbsp;&nbsp;&nbsp;<a
href="mapnik-module.html">Home</a>&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">
update python api docs and toch up formatting of __init__.py
2009-11-08 18:02:17 +01:00
Generated by Epydoc 3.0.1 on Sun Nov 8 09:00:49 2009
replaced 'epydocs' folder with 'api_docs/python' using revised api docstrings and custom css with epydoc
2009-03-30 07:20:00 +02: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>
Reference in a new issue Copy permalink