880 lines
30 KiB
HTML
880 lines
30 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.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> <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 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"> </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) -> 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.Layer-class.html#__getstate__" class="summary-sig-name">__getstate__</a>(<span class="summary-sig-arg">...</span>)</span><br />
|
|
__getstate__( (Layer)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.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]) -> None :
|
|
Create a Layer with a named string and, optionally, an srs string.</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<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"> </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) -> 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.Layer-class.html#envelope" class="summary-sig-name">envelope</a>(<span class="summary-sig-arg">...</span>)</span><br />
|
|
envelope( (Layer)arg1) -> Envelope :
|
|
Return the geographic envelope/bounding box.</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.Layer-class.html#visible" class="summary-sig-name">visible</a>(<span class="summary-sig-arg">...</span>)</span><br />
|
|
visible( (Layer)arg1, (float)arg2) -> 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"> </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"> </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.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"> </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"> </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"> </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"> </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"> </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"> </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"> </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"> </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"> </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"> </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"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
|
|
__getinitargs__( (Layer)arg1) -> 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"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
|
|
__getstate__( (Layer)arg1) -> 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"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
|
|
__init__( (object)arg1, (str)arg2 [, (str)arg3]) -> None :
|
|
Create a Layer with a named string and, optionally, an srs string.
|
|
|
|
The srs can be either a Proj.4 epsg code ('+init=epsg:<code>') or
|
|
of a Proj.4 literal ('+proj=<literal>').
|
|
If no srs is specified it will default to '+proj=latlong +datum=WGS84'
|
|
|
|
Usage:
|
|
>>> from mapnik import Layer
|
|
>>> lyr = Layer('My Layer','+proj=latlong +datum=WGS84')
|
|
>>> lyr
|
|
<mapnik._mapnik.Layer object at 0x6a270>
|
|
|
|
|
|
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"
|
|
>
|
|
</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__( (Layer)arg1, (tuple)arg2) -> 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"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
|
|
envelope( (Layer)arg1) -> Envelope :
|
|
Return the geographic envelope/bounding box.
|
|
Determined based on the layer datasource.
|
|
|
|
Usage:
|
|
>>> from mapnik import Layer
|
|
>>> lyr = Layer('My Layer','+proj=latlong +datum=WGS84')
|
|
>>> lyr.envelope()
|
|
Envelope(-1.0,-1.0,0.0,0.0) # default until a datasource is loaded
|
|
|
|
|
|
C++ signature :
|
|
mapnik::Envelope<double> 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"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
|
|
visible( (Layer)arg1, (float)arg2) -> bool :
|
|
Return True if this layer's data is active and visible at a given scale.
|
|
|
|
Otherwise returns False.
|
|
Accepts a scale value as an integer or float input.
|
|
Will return False if:
|
|
scale >= minzoom - 1e-6
|
|
or:
|
|
scale < maxzoom + 1e-6
|
|
|
|
Usage:
|
|
>>> from mapnik import Layer
|
|
>>> lyr = Layer('My Layer','+proj=latlong +datum=WGS84')
|
|
>>> lyr.visible(1.0/1000000)
|
|
True
|
|
>>> lyr.active = False
|
|
>>> 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: >>> from mapnik import Layer >>> lyr =
|
|
Layer('My Layer','+proj=latlong +datum=WGS84') >>> lyr.abstract
|
|
'' # default is en empty string >>> lyr.abstract = 'My Shapefile
|
|
rendered with Mapnik' >>> 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: >>> from mapnik import Layer >>> lyr =
|
|
Layer('My Layer','+proj=latlong +datum=WGS84') >>> lyr.active
|
|
True # Active by default >>> lyr.active = False # set False to
|
|
disable layer rendering >>> 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>
|
|
<p>Get/Set whether this layer's labels are cached.</p>
|
|
<p>Usage: TODO</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="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: >>> from mapnik import Layer, Datasource >>>
|
|
lyr = Layer('My Layer','+proj=latlong +datum=WGS84') >>>
|
|
lyr.datasource = Datasource(type='shape',file='world_borders')
|
|
>>> lyr.datasource <mapnik.Datasource object at
|
|
0x65470></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: >>> from mapnik import Layer >>> lyr =
|
|
Layer('My Layer','+proj=latlong +datum=WGS84') >>> lyr.maxzoom
|
|
1.7976931348623157e+308 # default is the numerical maximum >>>
|
|
lyr.maxzoom = 1.0/1000000 >>> 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: >>> from mapnik import Layer >>> lyr =
|
|
Layer('My Layer','+proj=latlong +datum=WGS84') >>> lyr.minzoom #
|
|
default is 0 0.0 >>> lyr.minzoom = 1.0/1000000 >>>
|
|
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: >>> from mapnik import Layer >>> lyr =
|
|
Layer('My Layer','+proj=latlong +datum=WGS84') >>> lyr.name 'My
|
|
Layer' >>> lyr.name = 'New Name' >>> 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: >>> from mapnik import Layer >>> lyr =
|
|
Layer('My Layer','+proj=latlong +datum=WGS84') >>> lyr.queryable
|
|
False # Not queryable by default >>> lyr.queryable = True
|
|
>>> 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>
|
|
<p>Get/Set the SRS of the layer.</p>
|
|
<p>Usage: >>> from mapnik import Layer >>> lyr =
|
|
Layer('My Layer','+proj=latlong +datum=WGS84') >>> lyr.srs
|
|
'+proj=latlong +datum=WGS84' # The default srs if not initialized with
|
|
custom srs >>> # set to google mercator with Proj.4 literal ...
|
|
>>> 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>
|
|
<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:
|
|
>>> from mapnik import Layer
|
|
>>> lyr = Layer('My Layer','+proj=latlong +datum=WGS84')
|
|
>>> lyr.styles
|
|
<mapnik._mapnik.Names object at 0x6d3e8>
|
|
>>> len(lyr.styles)
|
|
0
|
|
# no styles until you append them
|
|
lyr.styles.append('My Style') # mapnik uses named styles for flexibility
|
|
>>> len(lyr.styles)
|
|
1
|
|
>>> 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: >>> from mapnik import Layer >>> lyr =
|
|
Layer('My Layer','+proj=latlong +datum=WGS84') >>> lyr.title ''
|
|
>>> lyr.title = 'My first layer' >>> 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> <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>
|