atlas

Documentation

Overview

Package atlas provides an abstraction for a collection of Maps.

Index

• Constants
• Variables
• func AddMap(m Map)
• func GetCache() cache.Interface
• func PurgeMapTile(m Map, tile *tegola.Tile) error
• func SeedMapTile(ctx context.Context, m Map, z, x, y uint) error
• func SetCache(c cache.Interface)
• type Atlas
  • func (a *Atlas) AddMap(m Map)
  • func (a *Atlas) AllMaps() []Map
  • func (a *Atlas) GetCache() cache.Interface
  • func (a *Atlas) Map(mapName string) (Map, error)
  • func (a *Atlas) PurgeMapTile(m Map, tile *tegola.Tile) error
  • func (a *Atlas) SeedMapTile(ctx context.Context, m Map, z, x, y uint) error
  • func (a *Atlas) SetCache(c cache.Interface)
• type ErrMapNotFound
  • func (e ErrMapNotFound) Error() string
• type Layer
  • func (l *Layer) MVTName() string
• type Map
  • func AllMaps() []Map
  • func GetMap(mapName string) (Map, error)
  • func NewWebMercatorMap(name string) Map
  • func (m Map) AddDebugLayers() Map
  • func (m Map) Encode(ctx context.Context, tile *slippy.Tile) ([]byte, error)
  • func (m Map) FilterLayersByName(names ...string) Map
  • func (m Map) FilterLayersByZoom(zoom uint) Map
• type Tile

Constants

const (
	// MaxZoom will not render tile beyond this zoom level
	MaxZoom = tegola.MaxZ
)

Variables

var (
	ErrMissingCache = errors.New("atlas: missing cache")
	ErrMissingTile  = errors.New("atlas: missing tile")
)

Functions

func AddMap

func AddMap(m Map)

AddMap registers a map by name with defaultAtlas. if the map already exists it will be overwritten

func GetCache

func GetCache() cache.Interface

GetCache returns the registered cache for defaultAtlas, if one is registered, otherwise nil

func PurgeMapTile

func PurgeMapTile(m Map, tile *tegola.Tile) error

PurgeMapTile will purge a map tile from the configured cache backend for the defaultAtlas

func SeedMapTile

func SeedMapTile(ctx context.Context, m Map, z, x, y uint) error

SeedMapTile will generate a tile and persist it to the configured cache backend for the defaultAtlas

func SetCache

func SetCache(c cache.Interface)

SetCache sets the cache backend for defaultAtlas

Types

type Atlas

type Atlas struct {
	// for managing current access to the map container
	sync.RWMutex
	// contains filtered or unexported fields
}

Atlas holds a collection of maps. If the pointer to Atlas is nil, it will make use of the default atlas; as the container for maps. This is equaivalent to using the functions in the package. An Atlas is safe to use concurrently.

func (*Atlas) AddMap

func (a *Atlas) AddMap(m Map)

AddMap registers a map by name. if the map already exists it will be overwritten

func (*Atlas) AllMaps

func (a *Atlas) AllMaps() []Map

AllMaps returns a slice of all maps contained in the Atlas so far.

func (*Atlas) GetCache

func (a *Atlas) GetCache() cache.Interface

GetCache returns the registered cache if one is registered, otherwise nil

func (*Atlas) Map

func (a *Atlas) Map(mapName string) (Map, error)

Map looks up a Map by name and returns a copy of the Map

func (*Atlas) PurgeMapTile

func (a *Atlas) PurgeMapTile(m Map, tile *tegola.Tile) error

PurgeMapTile will purge a map tile from the configured cache backend

func (*Atlas) SeedMapTile

func (a *Atlas) SeedMapTile(ctx context.Context, m Map, z, x, y uint) error

SeedMapTile will generate a tile and persist it to the configured cache backend

func (*Atlas) SetCache

func (a *Atlas) SetCache(c cache.Interface)

SetCache sets the cache backend

type ErrMapNotFound

type ErrMapNotFound struct {
	Name string
}

func (ErrMapNotFound) Error

func (e ErrMapNotFound) Error() string

type Layer

type Layer struct {
	// optional. if not set, the ProviderLayerName will be used
	Name              string
	ProviderLayerName string
	MinZoom           uint
	MaxZoom           uint
	// instantiated provider
	Provider provider.Tiler
	// default tags to include when encoding the layer. provider tags take precedence
	DefaultTags map[string]interface{}
	GeomType    geom.Geometry
	// DontSimplify indicates wheather feature simplification should be applied.
	// We use a negative in the name so the default is to simplify
	DontSimplify bool
}

func (*Layer) MVTName

func (l *Layer) MVTName() string

MVTName will return the value that will be encoded in the Name field when the layer is encoded as MVT

type Map

type Map struct {
	Name string
	// Contains an attribution to be displayed when the map is shown to a user.
	// 	This string is sanatized so it can't be abused as a vector for XSS or beacon tracking.
	Attribution string
	// The maximum extent of available map tiles in WGS:84
	// latitude and longitude values, in the order left, bottom, right, top.
	// Default: [-180, -85, 180, 85]
	Bounds *geom.Extent
	// The first value is the longitude, the second is latitude (both in
	// WGS:84 values), the third value is the zoom level.
	Center [3]float64
	Layers []Layer

	SRID uint64
	// MVT output values
	TileExtent uint64
	TileBuffer uint64
}

func AllMaps

func AllMaps() []Map

AllMaps returns all registered maps in defaultAtlas

func GetMap

func GetMap(mapName string) (Map, error)

GetMap returns a copy of the a map by name from defaultAtlas. if the map does not exist it will return an error

func NewWebMercatorMap

func NewWebMercatorMap(name string) Map

NewMap creates a new map with the necessary default values

func (Map) AddDebugLayers

func (m Map) AddDebugLayers() Map

AddDebugLayers returns a copy of a Map with the debug layers appended to the layer list

func (Map) Encode

func (m Map) Encode(ctx context.Context, tile *slippy.Tile) ([]byte, error)

TODO (arolek): support for max zoom

func (Map) FilterLayersByName

func (m Map) FilterLayersByName(names ...string) Map

FilterLayersByName returns a copy of a Map with a subset of layers that match the supplied list of layer names

func (Map) FilterLayersByZoom

func (m Map) FilterLayersByZoom(zoom uint) Map

FilterLayersByZoom returns a copy of a Map with a subset of layers that match the given zoom

type Tile

type Tile struct {
	Z uint64
	X uint64
	Y uint64
}