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

881 lines
30 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.Layer</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> ::
<a href="mapnik._mapnik-module.html" onclick="show_private();">Module&nbsp;_mapnik</a> ::
Class&nbsp;Layer
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Layer</h1><p class="nomargin-top"></p>
<pre class="base-tree">
object --+
|
??.instance --+
|
<strong class="uidshort">Layer</strong>
</pre>
<hr />
<p>A Mapnik map layer.</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">&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.Layer-class.html#__getinitargs__" class="summary-sig-name">__getinitargs__</a>(<span class="summary-sig-arg">...</span>)</span><br />
__getinitargs__( (Layer)arg1) -&gt; 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">&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.Layer-class.html#__getstate__" class="summary-sig-name">__getstate__</a>(<span class="summary-sig-arg">...</span>)</span><br />
__getstate__( (Layer)arg1) -&gt; 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">&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.Layer-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">...</span>)</span><br />
__init__( (object)arg1, (str)arg2 [, (str)arg3]) -&gt; None :
+ update python api docs
2009-04-12 23:37:42 +02:00
Create a Layer with a named string and, optionally, an srs string.</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">
</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.Layer-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">&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.Layer-class.html#__setstate__" class="summary-sig-name">__setstate__</a>(<span class="summary-sig-arg">...</span>)</span><br />
__setstate__( (Layer)arg1, (tuple)arg2) -&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.Layer-class.html#envelope" class="summary-sig-name">envelope</a>(<span class="summary-sig-arg">...</span>)</span><br />
envelope( (Layer)arg1) -&gt; Envelope :
+ update python api docs
2009-04-12 23:37:42 +02:00
Return the geographic envelope/bounding box.</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">
</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.Layer-class.html#visible" class="summary-sig-name">visible</a>(<span class="summary-sig-arg">...</span>)</span><br />
visible( (Layer)arg1, (float)arg2) -&gt; bool :
Return True if this layer's data is active and visible at a given scale.</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">&nbsp;</span>
</td><td class="summary">
<a name="__instance_size__"></a><span class="summary-name">__instance_size__</span> = <code title="64">64</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</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">&nbsp;</span>
</td><td class="summary">
<a href="mapnik._mapnik.Layer-class.html#abstract" class="summary-name">abstract</a><br />
Get/Set the abstract of the 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.Layer-class.html#active" class="summary-name">active</a><br />
Get/Set whether this layer is active and will be rendered.
</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#clear_label_cache" class="summary-name">clear_label_cache</a><br />
Get/Set whether this layer's labels are cached.
</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#datasource" class="summary-name">datasource</a><br />
The datasource attached to this 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.Layer-class.html#maxzoom" class="summary-name">maxzoom</a><br />
Get/Set the maximum zoom lever of the 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.Layer-class.html#minzoom" class="summary-name">minzoom</a><br />
Get/Set the minimum zoom lever of the 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.Layer-class.html#name" class="summary-name">name</a><br />
Get/Set the name of the 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.Layer-class.html#queryable" class="summary-name">queryable</a><br />
Get/Set whether this layer is queryable.
</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#srs" class="summary-name">srs</a><br />
Get/Set the SRS of the 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.Layer-class.html#styles" class="summary-name">styles</a><br />
The styles list attached to this 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.Layer-class.html#title" class="summary-name">title</a><br />
Get/Set the title of the layer.
</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"
>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
__getinitargs__( (Layer)arg1) -&gt; tuple :
C++ signature :
boost::python::tuple __getinitargs__(mapnik::Layer)
</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"
>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
__getstate__( (Layer)arg1) -&gt; tuple :
C++ signature :
boost::python::tuple __getstate__(mapnik::Layer)
</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"
>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
__init__( (object)arg1, (str)arg2 [, (str)arg3]) -&gt; None :
+ update python api docs
2009-04-12 23:37:42 +02:00
Create a Layer with a named string and, optionally, an srs string.
The srs can be either a Proj.4 epsg code ('+init=epsg:&lt;code&gt;') or
of a Proj.4 literal ('+proj=&lt;literal&gt;').
replaced 'epydocs' folder with 'api_docs/python' using revised api docstrings and custom css with epydoc
2009-03-30 07:20:00 +02:00
If no srs is specified it will default to '+proj=latlong +datum=WGS84'
Usage:
&gt;&gt;&gt; from mapnik import Layer
&gt;&gt;&gt; lyr = Layer('My Layer','+proj=latlong +datum=WGS84')
&gt;&gt;&gt; lyr
&lt;mapnik._mapnik.Layer object at 0x6a270&gt;
+ update python api docs
2009-04-12 23:37:42 +02:00
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 __init__(_object*,std::string [,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"
>&nbsp;
</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"
>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
__setstate__( (Layer)arg1, (tuple)arg2) -&gt; None :
C++ signature :
void __setstate__(mapnik::Layer {lvalue},boost::python::tuple)
</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"
>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
envelope( (Layer)arg1) -&gt; Envelope :
+ update python api docs
2009-04-12 23:37:42 +02:00
Return the geographic envelope/bounding box.
Determined based on the layer datasource.
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 Layer
&gt;&gt;&gt; lyr = Layer('My Layer','+proj=latlong +datum=WGS84')
&gt;&gt;&gt; lyr.envelope()
Envelope(-1.0,-1.0,0.0,0.0) # default until a datasource is loaded
C++ signature :
mapnik::Envelope&lt;double&gt; envelope(mapnik::Layer {lvalue})
</pre>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="visible"></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">visible</span>(<span class="sig-arg">...</span>)</span>
</h3>
</td><td align="right" valign="top"
>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
visible( (Layer)arg1, (float)arg2) -&gt; bool :
Return True if this layer's data is active and visible at a given scale.
+ update python api docs
2009-04-12 23:37:42 +02:00
replaced 'epydocs' folder with 'api_docs/python' using revised api docstrings and custom css with epydoc
2009-03-30 07:20:00 +02:00
Otherwise returns False.
Accepts a scale value as an integer or float input.
Will return False if:
scale &gt;= minzoom - 1e-6
or:
scale &lt; maxzoom + 1e-6
Usage:
&gt;&gt;&gt; from mapnik import Layer
&gt;&gt;&gt; lyr = Layer('My Layer','+proj=latlong +datum=WGS84')
&gt;&gt;&gt; lyr.visible(1.0/1000000)
True
&gt;&gt;&gt; lyr.active = False
&gt;&gt;&gt; lyr.visible(1.0/1000000)
False
C++ signature :
bool visible(mapnik::Layer {lvalue},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="abstract"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">abstract</h3>
<p>Get/Set the abstract of the layer.</p>
<p>Usage: &gt;&gt;&gt; from mapnik import Layer &gt;&gt;&gt; lyr =
Layer('My Layer','+proj=latlong +datum=WGS84') &gt;&gt;&gt; lyr.abstract
'' # default is en empty string &gt;&gt;&gt; lyr.abstract = 'My Shapefile
rendered with Mapnik' &gt;&gt;&gt; lyr.abstract 'My Shapefile rendered
with Mapnik'</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="active"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">active</h3>
<p>Get/Set whether this layer is active and will be rendered.</p>
<p>Usage: &gt;&gt;&gt; from mapnik import Layer &gt;&gt;&gt; lyr =
Layer('My Layer','+proj=latlong +datum=WGS84') &gt;&gt;&gt; lyr.active
True # Active by default &gt;&gt;&gt; lyr.active = False # set False to
disable layer rendering &gt;&gt;&gt; lyr.active False</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="clear_label_cache"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">clear_label_cache</h3>
+ update python api docs
2009-04-12 23:37:42 +02:00
<p>Get/Set whether this layer's labels are cached.</p>
<p>Usage: TODO</p>
replaced 'epydocs' folder with 'api_docs/python' using revised api docstrings and custom css with epydoc
2009-03-30 07:20:00 +02:00
<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="datasource"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">datasource</h3>
<p>The datasource attached to this layer.</p>
<p>Usage: &gt;&gt;&gt; from mapnik import Layer, Datasource &gt;&gt;&gt;
lyr = Layer('My Layer','+proj=latlong +datum=WGS84') &gt;&gt;&gt;
lyr.datasource = Datasource(type='shape',file='world_borders')
&gt;&gt;&gt; lyr.datasource &lt;mapnik.Datasource object at
0x65470&gt;</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="maxzoom"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">maxzoom</h3>
<p>Get/Set the maximum zoom lever of the layer.</p>
<p>Usage: &gt;&gt;&gt; from mapnik import Layer &gt;&gt;&gt; lyr =
Layer('My Layer','+proj=latlong +datum=WGS84') &gt;&gt;&gt; lyr.maxzoom
1.7976931348623157e+308 # default is the numerical maximum &gt;&gt;&gt;
lyr.maxzoom = 1.0/1000000 &gt;&gt;&gt; lyr.maxzoom
9.9999999999999995e-07</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="minzoom"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">minzoom</h3>
<p>Get/Set the minimum zoom lever of the layer.</p>
<p>Usage: &gt;&gt;&gt; from mapnik import Layer &gt;&gt;&gt; lyr =
Layer('My Layer','+proj=latlong +datum=WGS84') &gt;&gt;&gt; lyr.minzoom #
default is 0 0.0 &gt;&gt;&gt; lyr.minzoom = 1.0/1000000 &gt;&gt;&gt;
lyr.minzoom 9.9999999999999995e-07</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="name"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">name</h3>
<p>Get/Set the name of the layer.</p>
<p>Usage: &gt;&gt;&gt; from mapnik import Layer &gt;&gt;&gt; lyr =
Layer('My Layer','+proj=latlong +datum=WGS84') &gt;&gt;&gt; lyr.name 'My
Layer' &gt;&gt;&gt; lyr.name = 'New Name' &gt;&gt;&gt; lyr.name 'New
Name'</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="queryable"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">queryable</h3>
<p>Get/Set whether this layer is queryable.</p>
<p>Usage: &gt;&gt;&gt; from mapnik import Layer &gt;&gt;&gt; lyr =
Layer('My Layer','+proj=latlong +datum=WGS84') &gt;&gt;&gt; lyr.queryable
False # Not queryable by default &gt;&gt;&gt; lyr.queryable = True
&gt;&gt;&gt; lyr.queryable True</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="srs"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">srs</h3>
+ update python api docs
2009-04-12 23:37:42 +02:00
<p>Get/Set the SRS of the layer.</p>
<p>Usage: &gt;&gt;&gt; from mapnik import Layer &gt;&gt;&gt; lyr =
Layer('My Layer','+proj=latlong +datum=WGS84') &gt;&gt;&gt; lyr.srs
'+proj=latlong +datum=WGS84' # The default srs if not initialized with
custom srs &gt;&gt;&gt; # set to google mercator with Proj.4 literal ...
&gt;&gt;&gt; lyr.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'</p>
replaced 'epydocs' folder with 'api_docs/python' using revised api docstrings and custom css with epydoc
2009-03-30 07:20:00 +02:00
<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="styles"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">styles</h3>
<pre class="literalblock">
The styles list attached to this layer.
Usage:
&gt;&gt;&gt; from mapnik import Layer
&gt;&gt;&gt; lyr = Layer('My Layer','+proj=latlong +datum=WGS84')
&gt;&gt;&gt; lyr.styles
&lt;mapnik._mapnik.Names object at 0x6d3e8&gt;
&gt;&gt;&gt; len(lyr.styles)
0
+ update python api docs
2009-04-12 23:37:42 +02:00
# no styles until you append them
lyr.styles.append('My Style') # mapnik uses named styles for flexibility
replaced 'epydocs' folder with 'api_docs/python' using revised api docstrings and custom css with epydoc
2009-03-30 07:20:00 +02:00
&gt;&gt;&gt; len(lyr.styles)
1
&gt;&gt;&gt; lyr.styles[0]
'My Style'
</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>
</dl>
</td></tr></table>
</div>
<a name="title"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">title</h3>
<p>Get/Set the title of the layer.</p>
<p>Usage: &gt;&gt;&gt; from mapnik import Layer &gt;&gt;&gt; lyr =
Layer('My Layer','+proj=latlong +datum=WGS84') &gt;&gt;&gt; lyr.title ''
&gt;&gt;&gt; lyr.title = 'My first layer' &gt;&gt;&gt; lyr.title 'My
first layer'</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>&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:50 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