1591 lines
49 KiB
HTML
1591 lines
49 KiB
HTML
<?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.Map</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> <a
|
|
href="mapnik-module.html">Home</a> </th>
|
|
|
|
<!-- Tree link -->
|
|
<th> <a
|
|
href="module-tree.html">Trees</a> </th>
|
|
|
|
<!-- Index link -->
|
|
<th> <a
|
|
href="identifier-index.html">Indices</a> </th>
|
|
|
|
<!-- Help link -->
|
|
<th> <a
|
|
href="help.html">Help</a> </th>
|
|
|
|
<!-- Project homepage -->
|
|
<th class="navbar" align="right" width="100%">
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><th class="navbar" align="center"
|
|
><a class="navbar" target="_top" href="http://mapnik.org">mapnik</a></th>
|
|
</tr></table></th>
|
|
</tr>
|
|
</table>
|
|
<table width="100%" cellpadding="0" cellspacing="0">
|
|
<tr valign="top">
|
|
<td width="100%">
|
|
<span class="breadcrumbs">
|
|
<a href="mapnik-module.html">Package mapnik</a> ::
|
|
<a href="mapnik._mapnik-module.html" onclick="show_private();">Module _mapnik</a> ::
|
|
Class Map
|
|
</span>
|
|
</td>
|
|
<td>
|
|
<table cellpadding="0" cellspacing="0">
|
|
<!-- hide/show private -->
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== CLASS DESCRIPTION ==================== -->
|
|
<h1 class="epydoc">Class Map</h1><p class="nomargin-top"></p>
|
|
<pre class="base-tree">
|
|
object --+
|
|
|
|
|
??.instance --+
|
|
|
|
|
<strong class="uidshort">Map</strong>
|
|
</pre>
|
|
|
|
<hr />
|
|
<p>The map object.</p>
|
|
|
|
<!-- ==================== INSTANCE METHODS ==================== -->
|
|
<a name="section-InstanceMethods"></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">Instance Methods</span></td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="mapnik._mapnik.Map-class.html#__getinitargs__" class="summary-sig-name">__getinitargs__</a>(<span class="summary-sig-arg">...</span>)</span><br />
|
|
__getinitargs__( (Map)arg1) -> tuple :</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="mapnik._mapnik.Map-class.html#__getstate__" class="summary-sig-name">__getstate__</a>(<span class="summary-sig-arg">...</span>)</span><br />
|
|
__getstate__( (Map)arg1) -> tuple :</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="mapnik._mapnik.Map-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">...</span>)</span><br />
|
|
__init__( (object)self, (int)width, (int)height [, (str)srs]) -> None :
|
|
Create a Map with a width and height as integers and, optionally,
|
|
an srs string either with a Proj.4 epsg code ('+init=epsg:<code>')
|
|
or with a Proj.4 literal ('+proj=<literal>').</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="mapnik._mapnik.Map-class.html#__reduce__" class="summary-sig-name">__reduce__</a>(<span class="summary-sig-arg">...</span>)</span><br />
|
|
helper for pickle</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="mapnik._mapnik.Map-class.html#__setstate__" class="summary-sig-name">__setstate__</a>(<span class="summary-sig-arg">...</span>)</span><br />
|
|
__setstate__( (Map)arg1, (tuple)arg2) -> None :</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="mapnik._mapnik.Map-class.html#append_style" class="summary-sig-name">append_style</a>(<span class="summary-sig-arg">...</span>)</span><br />
|
|
append_style( (Map)arg1, (str)arg2, (Style)arg3) -> bool :
|
|
Insert a Mapnik Style onto the map by appending it.</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="mapnik._mapnik.Map-class.html#buffered_envelope" class="summary-sig-name">buffered_envelope</a>(<span class="summary-sig-arg">...</span>)</span><br />
|
|
buffered_envelope( (Map)arg1) -> Envelope :
|
|
Get the Envelope() of the Map given
|
|
the Map.buffer_size.</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="mapnik._mapnik.Map-class.html#envelope" class="summary-sig-name">envelope</a>(<span class="summary-sig-arg">...</span>)</span><br />
|
|
envelope( (Map)arg1) -> Envelope :
|
|
Return the Map Envelope object
|
|
and print the string representation
|
|
of the current extent of the map.</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="mapnik._mapnik.Map-class.html#find_style" class="summary-sig-name">find_style</a>(<span class="summary-sig-arg">...</span>)</span><br />
|
|
find_style( (Map)arg1, (str)arg2) -> Style :
|
|
Query the Map for a style by name and return
|
|
a style object if found or raise KeyError
|
|
style if not found.</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="mapnik._mapnik.Map-class.html#get_aspect_fix_mode" class="summary-sig-name">get_aspect_fix_mode</a>(<span class="summary-sig-arg">...</span>)</span><br />
|
|
get_aspect_fix_mode( (Map)arg1) -> aspect_fix_mode :
|
|
Get aspect fix mode.</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="mapnik._mapnik.Map-class.html#pan" class="summary-sig-name">pan</a>(<span class="summary-sig-arg">...</span>)</span><br />
|
|
pan( (Map)arg1, (int)arg2, (int)arg3) -> None :
|
|
Set the Map center at a given x,y location
|
|
as integers in the coordinates of the pixmap or map surface.</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="mapnik._mapnik.Map-class.html#pan_and_zoom" class="summary-sig-name">pan_and_zoom</a>(<span class="summary-sig-arg">...</span>)</span><br />
|
|
pan_and_zoom( (Map)arg1, (int)arg2, (int)arg3, (float)arg4) -> None :
|
|
Set the Map center at a given x,y location
|
|
and zoom factor as a float.</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="mapnik._mapnik.Map-class.html#query_map_point" class="summary-sig-name">query_map_point</a>(<span class="summary-sig-arg">...</span>)</span><br />
|
|
query_map_point( (Map)arg1, (int)arg2, (float)arg3, (float)arg4) -> Featureset :
|
|
Query a Map Layer (by layer index) for features
|
|
intersecting the given x,y location in the coordinates
|
|
of the pixmap or map surface.</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="mapnik._mapnik.Map-class.html#query_point" class="summary-sig-name">query_point</a>(<span class="summary-sig-arg">...</span>)</span><br />
|
|
query_point( (Map)arg1, (int)arg2, (float)arg3, (float)arg4) -> Featureset :
|
|
Query a Map Layer (by layer index) for features
|
|
intersecting the given x,y location in the coordinates
|
|
of map projection.</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="mapnik._mapnik.Map-class.html#remove_all" class="summary-sig-name">remove_all</a>(<span class="summary-sig-arg">...</span>)</span><br />
|
|
remove_all( (Map)arg1) -> None :
|
|
Remove all Mapnik Styles and Layers from the Map.</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="mapnik._mapnik.Map-class.html#remove_style" class="summary-sig-name">remove_style</a>(<span class="summary-sig-arg">...</span>)</span><br />
|
|
remove_style( (Map)arg1, (str)arg2) -> None :
|
|
Remove a Mapnik Style from the map.</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="mapnik._mapnik.Map-class.html#resize" class="summary-sig-name">resize</a>(<span class="summary-sig-arg">...</span>)</span><br />
|
|
resize( (Map)arg1, (int)arg2, (int)arg3) -> None :
|
|
Resize a Mapnik Map.</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="mapnik._mapnik.Map-class.html#scale" class="summary-sig-name">scale</a>(<span class="summary-sig-arg">...</span>)</span><br />
|
|
scale( (Map)arg1) -> float :
|
|
Return the Map Scale.</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="mapnik._mapnik.Map-class.html#scale_denominator" class="summary-sig-name">scale_denominator</a>(<span class="summary-sig-arg">...</span>)</span><br />
|
|
scale_denominator( (Map)arg1) -> float :
|
|
Return the Map Scale Denominator.</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="mapnik._mapnik.Map-class.html#view_transform" class="summary-sig-name">view_transform</a>(<span class="summary-sig-arg">...</span>)</span><br />
|
|
view_transform( (Map)arg1) -> ViewTransform :
|
|
Map CoordinateTransform object.</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="mapnik._mapnik.Map-class.html#zoom" class="summary-sig-name">zoom</a>(<span class="summary-sig-arg">...</span>)</span><br />
|
|
zoom( (Map)arg1, (float)arg2) -> None :
|
|
Zoom in by a given factor.</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="mapnik._mapnik.Map-class.html#zoom_all" class="summary-sig-name">zoom_all</a>(<span class="summary-sig-arg">...</span>)</span><br />
|
|
zoom_all( (Map)arg1) -> None :
|
|
Set the geographical extent of the map
|
|
to the combined extents of all active layers.</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="mapnik._mapnik.Map-class.html#zoom_to_box" class="summary-sig-name">zoom_to_box</a>(<span class="summary-sig-arg">...</span>)</span><br />
|
|
zoom_to_box( (Map)arg1, (Envelope)arg2) -> None :
|
|
Set the geographical extent of the map
|
|
by specifying a Mapnik Envelope.</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2" class="summary">
|
|
<p class="indent-wrapped-lines"><b>Inherited from <code><i>unreachable</i>.instance</code></b>:
|
|
<code>__new__</code>
|
|
</p>
|
|
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
|
|
<code>__delattr__</code>,
|
|
<code>__getattribute__</code>,
|
|
<code>__hash__</code>,
|
|
<code>__reduce_ex__</code>,
|
|
<code>__repr__</code>,
|
|
<code>__setattr__</code>,
|
|
<code>__str__</code>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== CLASS VARIABLES ==================== -->
|
|
<a name="section-ClassVariables"></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">Class Variables</span></td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<a name="__instance_size__"></a><span class="summary-name">__instance_size__</span> = <code title="128">128</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<a name="__safe_for_unpickling__"></a><span class="summary-name">__safe_for_unpickling__</span> = <code title="True">True</code>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== PROPERTIES ==================== -->
|
|
<a name="section-Properties"></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">Properties</span></td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<a href="mapnik._mapnik.Map-class.html#aspect_fix_mode" class="summary-name">aspect_fix_mode</a><br />
|
|
Get/Set aspect fix mode.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<a href="mapnik._mapnik.Map-class.html#background" class="summary-name">background</a><br />
|
|
The background color of the map.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<a href="mapnik._mapnik.Map-class.html#buffer_size" class="summary-name">buffer_size</a><br />
|
|
Get/Set the size of buffer around map in pixels.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<a href="mapnik._mapnik.Map-class.html#height" class="summary-name">height</a><br />
|
|
Get/Set the height of the map in pixels.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<a href="mapnik._mapnik.Map-class.html#layers" class="summary-name">layers</a><br />
|
|
The list of map layers.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<a href="mapnik._mapnik.Map-class.html#srs" class="summary-name">srs</a><br />
|
|
Spatial reference in Proj.4 format.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<a href="mapnik._mapnik.Map-class.html#width" class="summary-name">width</a><br />
|
|
Get/Set the width of the map in pixels.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2" class="summary">
|
|
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
|
|
<code>__class__</code>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== METHOD DETAILS ==================== -->
|
|
<a name="section-MethodDetails"></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">Method Details</span></td>
|
|
</tr>
|
|
</table>
|
|
<a name="__getinitargs__"></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">__getinitargs__</span>(<span class="sig-arg">...</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
|
|
__getinitargs__( (Map)arg1) -> tuple :
|
|
|
|
C++ signature :
|
|
boost::python::tuple __getinitargs__(mapnik::Map)
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="__getstate__"></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">__getstate__</span>(<span class="sig-arg">...</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
|
|
__getstate__( (Map)arg1) -> tuple :
|
|
|
|
C++ signature :
|
|
boost::python::tuple __getstate__(mapnik::Map)
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="__init__"></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">__init__</span>(<span class="sig-arg">...</span>)</span>
|
|
<br /><em class="fname">(Constructor)</em>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
|
|
__init__( (object)self, (int)width, (int)height [, (str)srs]) -> None :
|
|
Create a Map with a width and height as integers and, optionally,
|
|
an srs string either with a Proj.4 epsg code ('+init=epsg:<code>')
|
|
or with a Proj.4 literal ('+proj=<literal>').
|
|
If no srs is specified the map will default to '+proj=latlong +datum=WGS84'
|
|
|
|
Usage:
|
|
>>> from mapnik import Map
|
|
>>> m = Map(600,400)
|
|
>>> m
|
|
<mapnik._mapnik.Map object at 0x6a240>
|
|
>>> m.srs
|
|
'+proj=latlong +datum=WGS84'
|
|
|
|
|
|
C++ signature :
|
|
void __init__(_object*,int,int [,std::string])
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
<dt>Overrides:
|
|
object.__init__
|
|
</dt>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="__reduce__"></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">__reduce__</span>(<span class="sig-arg">...</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<p>helper for pickle</p>
|
|
<dl class="fields">
|
|
<dt>Overrides:
|
|
object.__reduce__
|
|
<dd><em class="note">(inherited documentation)</em></dd>
|
|
</dt>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="__setstate__"></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">__setstate__</span>(<span class="sig-arg">...</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
|
|
__setstate__( (Map)arg1, (tuple)arg2) -> None :
|
|
|
|
C++ signature :
|
|
void __setstate__(mapnik::Map {lvalue},boost::python::tuple)
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="append_style"></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">append_style</span>(<span class="sig-arg">...</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
|
|
append_style( (Map)arg1, (str)arg2, (Style)arg3) -> bool :
|
|
Insert a Mapnik Style onto the map by appending it.
|
|
|
|
Usage:
|
|
>>> sty
|
|
<mapnik._mapnik.Style object at 0x6a330>
|
|
>>> m.append_style('Style Name', sty)
|
|
True # style object added to map by name
|
|
>>> m.append_style('Style Name', sty)
|
|
False # you can only append styles with unique names
|
|
|
|
|
|
C++ signature :
|
|
bool append_style(mapnik::Map {lvalue},std::string,mapnik::feature_type_style)
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="buffered_envelope"></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">buffered_envelope</span>(<span class="sig-arg">...</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
|
|
buffered_envelope( (Map)arg1) -> Envelope :
|
|
Get the Envelope() of the Map given
|
|
the Map.buffer_size.
|
|
|
|
Usage:
|
|
>>> m = Map(600,400)
|
|
>>> m.envelope()
|
|
Envelope(-1.0,-1.0,0.0,0.0)
|
|
>>> m.buffered_envelope()
|
|
Envelope(-1.0,-1.0,0.0,0.0)
|
|
>>> m.buffer_size = 1
|
|
>>> m.buffered_envelope()
|
|
Envelope(-1.02222222222,-1.02222222222,0.0222222222222,0.0222222222222)
|
|
|
|
|
|
C++ signature :
|
|
mapnik::Envelope<double> buffered_envelope(mapnik::Map {lvalue})
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="envelope"></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">envelope</span>(<span class="sig-arg">...</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
|
|
envelope( (Map)arg1) -> Envelope :
|
|
Return the Map Envelope object
|
|
and print the string representation
|
|
of the current extent of the map.
|
|
|
|
Usage:
|
|
>>> m.envelope()
|
|
Envelope(-0.185833333333,-0.96,0.189166666667,-0.71)
|
|
>>> dir(m.envelope())
|
|
...'center', 'contains', 'expand_to_include', 'forward',
|
|
...'height', 'intersect', 'intersects', 'inverse', 'maxx',
|
|
...'maxy', 'minx', 'miny', 'width'
|
|
|
|
|
|
C++ signature :
|
|
mapnik::Envelope<double> envelope(mapnik::Map {lvalue})
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="find_style"></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">find_style</span>(<span class="sig-arg">...</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
|
|
find_style( (Map)arg1, (str)arg2) -> Style :
|
|
Query the Map for a style by name and return
|
|
a style object if found or raise KeyError
|
|
style if not found.
|
|
|
|
Usage:
|
|
>>> m.find_style('Style Name')
|
|
<mapnik._mapnik.Style object at 0x654f0>
|
|
|
|
|
|
C++ signature :
|
|
mapnik::feature_type_style find_style(mapnik::Map,std::string)
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="get_aspect_fix_mode"></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">get_aspect_fix_mode</span>(<span class="sig-arg">...</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
|
|
get_aspect_fix_mode( (Map)arg1) -> aspect_fix_mode :
|
|
Get aspect fix mode.
|
|
Usage:
|
|
|
|
>>> m.get_aspect_fix_mode()
|
|
|
|
|
|
C++ signature :
|
|
mapnik::Map::aspect_fix_mode get_aspect_fix_mode(mapnik::Map {lvalue})
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="pan"></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">pan</span>(<span class="sig-arg">...</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
|
|
pan( (Map)arg1, (int)arg2, (int)arg3) -> None :
|
|
Set the Map center at a given x,y location
|
|
as integers in the coordinates of the pixmap or map surface.
|
|
|
|
Usage:
|
|
>>> m = Map(600,400)
|
|
>>> m.envelope().center()
|
|
Coord(-0.5,-0.5) # default Map center
|
|
>>> m.pan(-1,-1)
|
|
>>> m.envelope().center()
|
|
Coord(0.00166666666667,-0.835)
|
|
|
|
|
|
C++ signature :
|
|
void pan(mapnik::Map {lvalue},int,int)
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="pan_and_zoom"></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">pan_and_zoom</span>(<span class="sig-arg">...</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
|
|
pan_and_zoom( (Map)arg1, (int)arg2, (int)arg3, (float)arg4) -> None :
|
|
Set the Map center at a given x,y location
|
|
and zoom factor as a float.
|
|
|
|
Usage:
|
|
>>> m = Map(600,400)
|
|
>>> m.envelope().center()
|
|
Coord(-0.5,-0.5) # default Map center
|
|
>>> m.scale()
|
|
-0.0016666666666666668
|
|
>>> m.pan_and_zoom(-1,-1,0.25)
|
|
>>> m.scale()
|
|
0.00062500000000000001
|
|
|
|
|
|
C++ signature :
|
|
void pan_and_zoom(mapnik::Map {lvalue},int,int,double)
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="query_map_point"></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">query_map_point</span>(<span class="sig-arg">...</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
|
|
query_map_point( (Map)arg1, (int)arg2, (float)arg3, (float)arg4) -> Featureset :
|
|
Query a Map Layer (by layer index) for features
|
|
intersecting the given x,y location in the coordinates
|
|
of the pixmap or map surface.
|
|
Will return a Mapnik Featureset if successful
|
|
otherwise will return None.
|
|
|
|
Usage:
|
|
>>> feat = m.query_map_point(0,200,200)
|
|
>>> feat
|
|
>>> <mapnik._mapnik.Featureset object at 0x5fe1f0>
|
|
>>> feat.next()
|
|
>>> <mapnik._mapnik.Feature object at 0x5fe230>
|
|
|
|
|
|
C++ signature :
|
|
boost::shared_ptr<mapnik::Featureset> query_map_point(mapnik::Map {lvalue},unsigned int,double,double)
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="query_point"></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">query_point</span>(<span class="sig-arg">...</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
|
|
query_point( (Map)arg1, (int)arg2, (float)arg3, (float)arg4) -> Featureset :
|
|
Query a Map Layer (by layer index) for features
|
|
intersecting the given x,y location in the coordinates
|
|
of map projection.
|
|
Will return a Mapnik Featureset if successful
|
|
otherwise will return None.
|
|
|
|
Usage:
|
|
>>> feat = m.query_point(0,-122,48)
|
|
>>> feat
|
|
>>> <mapnik._mapnik.Featureset object at 0x5fe130>
|
|
>>> feat.next()
|
|
>>> <mapnik._mapnik.Feature object at 0x5fe1b0>
|
|
|
|
|
|
C++ signature :
|
|
boost::shared_ptr<mapnik::Featureset> query_point(mapnik::Map {lvalue},unsigned int,double,double)
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="remove_all"></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">remove_all</span>(<span class="sig-arg">...</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
|
|
remove_all( (Map)arg1) -> None :
|
|
Remove all Mapnik Styles and Layers from the Map.
|
|
|
|
Usage:
|
|
>>> m.remove_all()
|
|
|
|
|
|
C++ signature :
|
|
void remove_all(mapnik::Map {lvalue})
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="remove_style"></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">remove_style</span>(<span class="sig-arg">...</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
|
|
remove_style( (Map)arg1, (str)arg2) -> None :
|
|
Remove a Mapnik Style from the map.
|
|
|
|
Usage:
|
|
>>> m.remove_style('Style Name')
|
|
|
|
|
|
C++ signature :
|
|
void remove_style(mapnik::Map {lvalue},std::string)
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="resize"></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">resize</span>(<span class="sig-arg">...</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
|
|
resize( (Map)arg1, (int)arg2, (int)arg3) -> None :
|
|
Resize a Mapnik Map.
|
|
|
|
Usage:
|
|
>>> m.resize(64,64)
|
|
|
|
|
|
C++ signature :
|
|
void resize(mapnik::Map {lvalue},unsigned int,unsigned int)
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="scale"></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</span>(<span class="sig-arg">...</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
|
|
scale( (Map)arg1) -> float :
|
|
Return the Map Scale.
|
|
Usage:
|
|
|
|
>>> m.scale()
|
|
|
|
|
|
C++ signature :
|
|
double scale(mapnik::Map {lvalue})
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="scale_denominator"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr valign="top"><td>
|
|
<h3 class="epydoc"><span class="sig"><span class="sig-name">scale_denominator</span>(<span class="sig-arg">...</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
|
|
scale_denominator( (Map)arg1) -> float :
|
|
Return the Map Scale Denominator.
|
|
Usage:
|
|
|
|
>>> m.scale_denominator
|
|
|
|
|
|
C++ signature :
|
|
double scale_denominator(mapnik::Map {lvalue})
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="view_transform"></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">view_transform</span>(<span class="sig-arg">...</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
|
|
view_transform( (Map)arg1) -> ViewTransform :
|
|
Map CoordinateTransform object.
|
|
|
|
Usage:
|
|
>>> m.view_transform()
|
|
|
|
|
|
C++ signature :
|
|
mapnik::CoordTransform view_transform(mapnik::Map {lvalue})
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="zoom"></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">zoom</span>(<span class="sig-arg">...</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
|
|
zoom( (Map)arg1, (float)arg2) -> None :
|
|
Zoom in by a given factor.
|
|
Usage:
|
|
|
|
>>> m.zoom(0.25)
|
|
|
|
|
|
C++ signature :
|
|
void zoom(mapnik::Map {lvalue},double)
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="zoom_all"></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">zoom_all</span>(<span class="sig-arg">...</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
|
|
zoom_all( (Map)arg1) -> None :
|
|
Set the geographical extent of the map
|
|
to the combined extents of all active layers.
|
|
|
|
Usage:
|
|
>>> m.zoom_all()
|
|
|
|
|
|
C++ signature :
|
|
void zoom_all(mapnik::Map {lvalue})
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="zoom_to_box"></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">zoom_to_box</span>(<span class="sig-arg">...</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
|
|
zoom_to_box( (Map)arg1, (Envelope)arg2) -> None :
|
|
Set the geographical extent of the map
|
|
by specifying a Mapnik Envelope.
|
|
|
|
Usage:
|
|
>>> extext = Envelope(-180.0, -90.0, 180.0, 90.0)
|
|
>>> m.zoom_to_box(extent)
|
|
|
|
|
|
C++ signature :
|
|
void zoom_to_box(mapnik::Map {lvalue},mapnik::Envelope<double>)
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<br />
|
|
<!-- ==================== PROPERTY DETAILS ==================== -->
|
|
<a name="section-PropertyDetails"></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">Property Details</span></td>
|
|
</tr>
|
|
</table>
|
|
<a name="aspect_fix_mode"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<h3 class="epydoc">aspect_fix_mode</h3>
|
|
<p>Get/Set aspect fix mode. Usage:</p>
|
|
<pre class="py-doctest">
|
|
<span class="py-prompt">>>> </span>m.aspect_fix_mode = aspect_fix_mode.GROW_BBOX</pre>
|
|
<dl class="fields">
|
|
<dt>Get Method:</dt>
|
|
<dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
|
|
</dd>
|
|
<dt>Set Method:</dt>
|
|
<dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
|
|
</dd>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="background"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<h3 class="epydoc">background</h3>
|
|
<p>The background color of the map.</p>
|
|
<p>Usage: >>> m.background = Color('steelblue')</p>
|
|
<dl class="fields">
|
|
<dt>Get Method:</dt>
|
|
<dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
|
|
</dd>
|
|
<dt>Set Method:</dt>
|
|
<dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
|
|
</dd>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="buffer_size"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<h3 class="epydoc">buffer_size</h3>
|
|
<p>Get/Set the size of buffer around map in pixels.</p>
|
|
<p>Usage: >>> m.buffer_size 0 # zero by default >>>
|
|
m.buffer_size = 2 >>> m.buffer_size 2</p>
|
|
<dl class="fields">
|
|
<dt>Get Method:</dt>
|
|
<dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
|
|
</dd>
|
|
<dt>Set Method:</dt>
|
|
<dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
|
|
</dd>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="height"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<h3 class="epydoc">height</h3>
|
|
<p>Get/Set the height of the map in pixels. Minimum settable size is 16
|
|
pixels.</p>
|
|
<p>Usage: >>> m.height 400 >>> m.height = 600
|
|
>>> m.height 600</p>
|
|
<dl class="fields">
|
|
<dt>Get Method:</dt>
|
|
<dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
|
|
</dd>
|
|
<dt>Set Method:</dt>
|
|
<dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
|
|
</dd>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="layers"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<h3 class="epydoc">layers</h3>
|
|
<p>The list of map layers.</p>
|
|
<p>Usage: >>> m.layers <mapnik._mapnik.Layers object at
|
|
0x6d458>>>> m.layers[0] <mapnik._mapnik.Layer object at
|
|
0x5fe130></p>
|
|
<dl class="fields">
|
|
<dt>Get Method:</dt>
|
|
<dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
|
|
</dd>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="srs"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<h3 class="epydoc">srs</h3>
|
|
<pre class="literalblock">
|
|
Spatial reference in Proj.4 format.
|
|
Either an epsg code or proj literal.
|
|
For example, a proj literal:
|
|
'+proj=latlong +datum=WGS84'
|
|
and a proj epsg code:
|
|
'+init=epsg:4326'
|
|
|
|
Note: using epsg codes requires the installation of
|
|
the Proj.4 'epsg' data file normally found in '/usr/local/share/proj'
|
|
|
|
Usage:
|
|
>>> m.srs
|
|
'+proj=latlong +datum=WGS84' # The default srs if not initialized with custom srs
|
|
>>> # set to google mercator with Proj.4 literal
|
|
...
|
|
>>> m.srs = '+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0 +k=1.0 +units=m +nadgrids=@null +no_defs +over'
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
<dt>Get Method:</dt>
|
|
<dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
|
|
</dd>
|
|
<dt>Set Method:</dt>
|
|
<dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
|
|
</dd>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="width"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<h3 class="epydoc">width</h3>
|
|
<p>Get/Set the width of the map in pixels. Minimum settable size is 16
|
|
pixels.</p>
|
|
<p>Usage: >>> m.width 600 >>> m.width = 800
|
|
>>> m.width 800</p>
|
|
<dl class="fields">
|
|
<dt>Get Method:</dt>
|
|
<dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
|
|
</dd>
|
|
<dt>Set Method:</dt>
|
|
<dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
|
|
</dd>
|
|
</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> <a
|
|
href="mapnik-module.html">Home</a> </th>
|
|
|
|
<!-- Tree link -->
|
|
<th> <a
|
|
href="module-tree.html">Trees</a> </th>
|
|
|
|
<!-- Index link -->
|
|
<th> <a
|
|
href="identifier-index.html">Indices</a> </th>
|
|
|
|
<!-- Help link -->
|
|
<th> <a
|
|
href="help.html">Help</a> </th>
|
|
|
|
<!-- Project homepage -->
|
|
<th class="navbar" align="right" width="100%">
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><th class="navbar" align="center"
|
|
><a class="navbar" target="_top" href="http://mapnik.org">mapnik</a></th>
|
|
</tr></table></th>
|
|
</tr>
|
|
</table>
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
|
<tr>
|
|
<td align="left" class="footer">
|
|
Generated by Epydoc 3.0.1 on Sun Apr 12 14:37:26 2009
|
|
</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>
|