Copyright | (c) Mike Pilgrem 2017 |
---|---|
Maintainer | public@pilgrem.com |
Stability | experimental |
Safe Haskell | None |
Language | Haskell2010 |
This module has no connection with Google Inc. or its affiliates.
The Google Static Maps API returns a map as an image via an HTTP request. This library provides bindings in Haskell to that API (version 2).
NB: The use of the Google Static Maps API services is subject to the Google Maps APIs Terms of Service, which terms restrict the use of content.
The following are not yet implemented: certain optional parameters
(language
, and region
); address locations; non-PNG image
formats; and encoded polyline paths.
The code below is an example console application to test the use of the library with the Google Static Maps API.
{-# LANGUAGE OverloadedStrings #-} module Main (main) where import Data.Maybe (fromJust) import Graphics.Gloss (Display (..), display, white) -- package gloss import Graphics.Gloss.Juicy (fromDynamicImage) -- package gloss-juicy import Network.HTTP.Client (newManager) import Network.HTTP.Client.TLS (tlsManagerSettings) import Web.Google.Static.Maps (Center (..), Key (..), Location (..), Size (..), staticmap, StaticmapResponse (..), Zoom (..)) main :: IO () main = do putStrLn "A test of the Google Static Maps API.\nNB: The use of the \ \API services is subject to the Google Maps APIs Terms of Serivce \ \at https://developers.google.com/maps/terms.\n" mgr <- newManager tlsManagerSettings let apiKey = Key "<REPLACE_THIS_WITH_YOUR_ACTUAL_GOOGLE_API_KEY>" center = Just $ Center (Location 42.165950 (-71.362015)) zoom = Just $ Zoom 17 w = 400 h = 400 size = Size w h result <- staticmap mgr apiKey Nothing center zoom size Nothing Nothing [] Nothing [] [] Nothing case result of Right response -> do let picture = fromJust $ fromDynamicImage response title = "Test Google Static Maps API" window = InWindow title (w, h) (10, 10) display window white picture Left err -> putStrLn $ "Error! Result:\n" ++ show err
- staticmap :: Manager -> Key -> Maybe Signature -> Maybe Center -> Maybe Zoom -> Size -> Maybe Scale -> Maybe Format -> [MapStyle] -> Maybe MapType -> [Markers] -> [Path] -> Maybe Visible -> IO (Either ServantError StaticmapResponse)
- type GoogleStaticMapsAPI = "staticmap" :> (QueryParam "key" Key :> (QueryParam "signature" Signature :> (QueryParam "center" Center :> (QueryParam "zoom" Zoom :> (QueryParam "size" Size :> (QueryParam "scale" Scale :> (QueryParam "format" Format :> (QueryParams "style" MapStyle :> (QueryParam "maptype" MapType :> (QueryParams "markers" Markers :> (QueryParams "path" Path :> (QueryParam "visible" Visible :> Get '[PNG] StaticmapResponse))))))))))))
- api :: Proxy GoogleStaticMapsAPI
- newtype Key = Key Text
- newtype Signature = Signature Text
- newtype Center = Center Location
- data Location = Location {}
- newtype Zoom = Zoom Int
- data Size = Size {}
- data Scale
- data Format
- data MapType
- data MapStyle = MapStyle (Maybe Feature) (Maybe Element) [MapStyleOp]
- data Feature
- = AllFeatures
- | Administrative
- | AdministrativeCountry
- | AdministrativeLandParcel
- | AdministrativeLocality
- | AdministrativeNeighborhood
- | AdministrativeProvince
- | Landscape
- | LandscapeManMade
- | LandscapeNatural
- | LandscapeNaturalLandcover
- | LandscapeNaturalTerrain
- | Poi
- | PoiAttraction
- | PoiBusiness
- | PoiGovernment
- | PoiMedical
- | PoiPark
- | PoiPlaceOfWorship
- | PoiSchool
- | PoiSportsComplex
- | Road
- | RoadArterial
- | RoadHighway
- | RoadHighwayControlledAccess
- | RoadLocal
- | Transit
- | TransitLine
- | TransitStation
- | TransitStationAirport
- | TransitStationBus
- | TransitStationRail
- | Water
- data Element
- data MapStyleOp
- data Visibility
- = On
- | Off
- | Simplified
- data Markers = Markers (Maybe MarkerStyle) [Location]
- data MarkerStyle
- = StdMarkerStyle { }
- | CustomIcon { }
- data MarkerSize
- data MarkerColor
- newtype MarkerLabel = MarkerLabel Char
- data StdColor
- data URI :: * = URI {}
- data URIAuth :: * = URIAuth {
- uriUserInfo :: String
- uriRegName :: String
- uriPort :: String
- data Anchor
- data StdAnchor
- data Path = Path (Maybe PathStyle) [Location]
- data PathStyle = PathStyle {}
- newtype PathWeight = PathWeight Int
- data PathColor
- newtype PathGeodesic = PathGeodesic Bool
- newtype Visible = Visible [Location]
- type StaticmapResponse = DynamicImage
Functions
staticmap :: Manager -> Key -> Maybe Signature -> Maybe Center -> Maybe Zoom -> Size -> Maybe Scale -> Maybe Format -> [MapStyle] -> Maybe MapType -> [Markers] -> [Path] -> Maybe Visible -> IO (Either ServantError StaticmapResponse) Source #
Retrieve a static map. NB: The use of the Google Static Maps API services is subject to the Google Maps APIs Terms of Service.
API
type GoogleStaticMapsAPI = "staticmap" :> (QueryParam "key" Key :> (QueryParam "signature" Signature :> (QueryParam "center" Center :> (QueryParam "zoom" Zoom :> (QueryParam "size" Size :> (QueryParam "scale" Scale :> (QueryParam "format" Format :> (QueryParams "style" MapStyle :> (QueryParam "maptype" MapType :> (QueryParams "markers" Markers :> (QueryParams "path" Path :> (QueryParam "visible" Visible :> Get '[PNG] StaticmapResponse)))))))))))) Source #
Google Static Maps API
api :: Proxy GoogleStaticMapsAPI Source #
API type
Types
Signature
Center of the map: not required if the map includes markers or paths.
Location: precision in latitude or longitude beyond 6 decimal places is ignored.
Zoom level: the lowest level, in which the whole world can be seen, is 0. Each succeeding level doubles the precision. Not required if the map includes markers or paths.
Size in pixels: there are maximum allowable values.
Scale
Image format
Map type
MapStyle
Map feature
Feature element
data MapStyleOp Source #
Map style operation
Markers
data MarkerSize Source #
Marker size
data MarkerColor Source #
Marker colour
newtype MarkerLabel Source #
Marker label character
Standard colours
Represents a general universal resource identifier using its component parts.
For example, for the URI
foo://anonymous@www.haskell.org:42/ghc?query#frag
the components are:
Type for authority value within a URI
URIAuth | |
|
Anchor
Standard anchor points
Path
Path style: a geodesic path follows the curvature of the Earth.
PathStyle | |
|
newtype PathWeight Source #
Path weight: in pixels.
Path colour
newtype PathGeodesic Source #
Path is geodesic
Visible locations
type StaticmapResponse = DynamicImage Source #
StaticmapResponse