Welcome to django-vectortiles’s documentation!

INSTALLATION

Requirements

  • You need to install geodjango required libraries (See here)

PostGIS 2.4+ backend usage

  • You need a PostgreSQL database with PostGIS 2.4+ extension enabled. (See here)

  • You need to enable and use django.contrib.gis.db.backends.postgis database backend

pip install psycopg2
pip install django-vectortiles

Other database backend usages

pip install django-vectortiles[mapbox]

This will include subdependencies to generate vector tiles from mapbox_vector_tiles python library.

USAGE

Simple model view

# in your app models.py
from django.contrib.gis.db import models

class Feature(models.Model):
    geom = models.GeometryField(srid=4326)
    name = models.CharField(max_length=250)

# in your view file
from django.views.generic import ListView
from vectortiles.postgis.views import MVTView
from yourapp.models import Feature


class FeatureTileView(MVTView, ListView):
    model = Feature
    vector_tile_layer_name = "features"  # name for data layer in vector tile
    vector_tile_fields = ('name',)  # model fields or queryset annotates to include in tile
    # vector_tile_content_type = "application/x-protobuf"  # if you want to use custom content_type
    # vector_tile_queryset = None  # define a queryset for your features
    # vector_tile_queryset_limit = None  # as queryset could not be sliced, set here a limit for your features per tile
    # vector_tile_geom_name = "geom"  # geom field to consider in qs
    # vector_tile_extent = 4096  # tile extent
    # vector_tile_buffer = 256  # buffer around tile

# in your urls file
from django.urls import path
from yourapp import views


urlpatterns = [
    ...
    path('tiles/<int:z>/<int:x>/<int:y>', views.FeatureTileView.as_view(), name="feature-tile"),
    ...
]

Indices and tables