<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>GeoJSON Serializer — Django 1.8.19 documentation</title>
<link rel="stylesheet" href="../../../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '1.8.19',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<link rel="top" title="Django 1.8.19 documentation" href="../../../contents.html" />
<link rel="up" title="GeoDjango Utilities" href="utils.html" />
<link rel="next" title="GeoDjango Management Commands" href="commands.html" />
<link rel="prev" title="OGR Inspection" href="ogrinspect.html" />
<script type="text/javascript" src="../../../templatebuiltins.js"></script>
<script type="text/javascript">
(function($) {
if (!django_template_builtins) {
// templatebuiltins.js missing, do nothing.
return;
}
$(document).ready(function() {
// Hyperlink Django template tags and filters
var base = "../../templates/builtins.html";
if (base == "#") {
// Special case for builtins.html itself
base = "";
}
// Tags are keywords, class '.k'
$("div.highlight\\-html\\+django span.k").each(function(i, elem) {
var tagname = $(elem).text();
if ($.inArray(tagname, django_template_builtins.ttags) != -1) {
var fragment = tagname.replace(/_/, '-');
$(elem).html("<a href='" + base + "#" + fragment + "'>" + tagname + "</a>");
}
});
// Filters are functions, class '.nf'
$("div.highlight\\-html\\+django span.nf").each(function(i, elem) {
var filtername = $(elem).text();
if ($.inArray(filtername, django_template_builtins.tfilters) != -1) {
var fragment = filtername.replace(/_/, '-');
$(elem).html("<a href='" + base + "#" + fragment + "'>" + filtername + "</a>");
}
});
});
})(jQuery);
</script>
</head>
<body role="document">
<div class="document">
<div id="custom-doc" class="yui-t6">
<div id="hd">
<h1><a href="../../../index.html">Django 1.8.19 documentation</a></h1>
<div id="global-nav">
<a title="Home page" href="../../../index.html">Home</a> |
<a title="Table of contents" href="../../../contents.html">Table of contents</a> |
<a title="Global index" href="../../../genindex.html">Index</a> |
<a title="Module index" href="../../../py-modindex.html">Modules</a>
</div>
<div class="nav">
« <a href="ogrinspect.html" title="OGR Inspection">previous</a>
|
<a href="../../index.html" title="API Reference" accesskey="U">up</a>
|
<a href="commands.html" title="GeoDjango Management Commands">next</a> »</div>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<div class="yui-g" id="ref-contrib-gis-serializers">
<div class="section" id="s-geojson-serializer">
<span id="geojson-serializer"></span><h1>GeoJSON Serializer<a class="headerlink" href="#geojson-serializer" title="Permalink to this headline">ΒΆ</a></h1>
<div class="versionadded">
<span class="title">New in Django 1.8.</span> </div>
<span class="target" id="module-django.contrib.gis.serializers.geojson"></span><p>GeoDjango provides a specific serializer for the <a class="reference external" href="http://geojson.org/">GeoJSON</a> format. The GDAL
library is required for this serializer. See <a class="reference internal" href="../../../topics/serialization.html"><span class="doc">Serializing Django objects</span></a> for
more information on serialization.</p>
<p>The <code class="docutils literal"><span class="pre">geojson</span></code> serializer is not meant for round-tripping data, as it has no
deserializer equivalent. For example, you cannot use <a class="reference internal" href="../../django-admin.html#django-admin-loaddata"><code class="xref std std-djadmin docutils literal"><span class="pre">loaddata</span></code></a> to
reload the output produced by this serializer. If you plan to reload the
outputted data, use the plain <a class="reference internal" href="../../../topics/serialization.html#serialization-formats-json"><span class="std std-ref">json serializer</span></a>
instead.</p>
<p>In addition to the options of the <code class="docutils literal"><span class="pre">json</span></code> serializer, the <code class="docutils literal"><span class="pre">geojson</span></code>
serializer accepts the following additional option when it is called by
<code class="docutils literal"><span class="pre">serializers.serialize()</span></code>:</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">geometry_field</span></code>: A string containing the name of a geometry field to use
for the <code class="docutils literal"><span class="pre">geometry</span></code> key of the GeoJSON feature. This is only needed when you
have a model with more than one geometry field and you don’t want to use the
first defined geometry field (by default, the first geometry field is picked).</li>
<li><code class="docutils literal"><span class="pre">srid</span></code>: The SRID to use for the <code class="docutils literal"><span class="pre">geometry</span></code> content. Defaults to 4326
(WGS 84).</li>
</ul>
<p>The <a class="reference internal" href="../../../topics/serialization.html#subset-of-fields"><span class="std std-ref">fields</span></a> option can be used to limit fields that
will be present in the <code class="docutils literal"><span class="pre">properties</span></code> key, as it works with all other
serializers.</p>
<p>Example:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">django.core.serializers</span> <span class="k">import</span> <span class="n">serialize</span>
<span class="kn">from</span> <span class="nn">my_app.models</span> <span class="k">import</span> <span class="n">City</span>
<span class="n">serialize</span><span class="p">(</span><span class="s1">'geojson'</span><span class="p">,</span> <span class="n">City</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">all</span><span class="p">(),</span>
<span class="n">geometry_field</span><span class="o">=</span><span class="s1">'point'</span><span class="p">,</span>
<span class="n">fields</span><span class="o">=</span><span class="p">(</span><span class="s1">'name'</span><span class="p">,))</span>
</pre></div>
</div>
<p>Would output:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s1">'type'</span><span class="p">:</span> <span class="s1">'FeatureCollection'</span><span class="p">,</span>
<span class="s1">'crs'</span><span class="p">:</span> <span class="p">{</span>
<span class="s1">'type'</span><span class="p">:</span> <span class="s1">'name'</span><span class="p">,</span>
<span class="s1">'properties'</span><span class="p">:</span> <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'EPSG:4326'</span><span class="p">}</span>
<span class="p">},</span>
<span class="s1">'features'</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s1">'type'</span><span class="p">:</span> <span class="s1">'Feature'</span><span class="p">,</span>
<span class="s1">'geometry'</span><span class="p">:</span> <span class="p">{</span>
<span class="s1">'type'</span><span class="p">:</span> <span class="s1">'Point'</span><span class="p">,</span>
<span class="s1">'coordinates'</span><span class="p">:</span> <span class="p">[</span><span class="o">-</span><span class="mf">87.650175</span><span class="p">,</span> <span class="mf">41.850385</span><span class="p">]</span>
<span class="p">},</span>
<span class="s1">'properties'</span><span class="p">:</span> <span class="p">{</span>
<span class="s1">'name'</span><span class="p">:</span> <span class="s1">'Chicago'</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
<div class="yui-b" id="sidebar">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3>Browse</h3>
<ul>
<li>Prev: <a href="ogrinspect.html">OGR Inspection</a></li>
<li>Next: <a href="commands.html">GeoDjango Management Commands</a></li>
</ul>
<h3>You are here:</h3>
<ul>
<li>
<a href="../../../index.html">Django 1.8.19 documentation</a>
<ul><li><a href="../../index.html">API Reference</a>
<ul><li><a href="../index.html"><code class="docutils literal"><span class="pre">contrib</span></code> packages</a>
<ul><li><a href="index.html">GeoDjango</a>
<ul><li><a href="utils.html">GeoDjango Utilities</a>
<ul><li>GeoJSON Serializer</li></ul>
</li></ul></li></ul></li></ul></li></ul>
</li>
</ul>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../../_sources/ref/contrib/gis/serializers.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../../../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<h3>Last update:</h3>
<p class="topless">Jan 06, 2019</p>
</div>
</div>
<div id="ft">
<div class="nav">
« <a href="ogrinspect.html" title="OGR Inspection">previous</a>
|
<a href="../../index.html" title="API Reference" accesskey="U">up</a>
|
<a href="commands.html" title="GeoDjango Management Commands">next</a> »</div>
</div>
</div>
<div class="clearer"></div>
</div>
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
3f388dbb5c0ba9abe7c510467d6cc65d
>
files
>
729
