imjasonh/staticmaps
1
0
Fork 0
mirror of https://github.com/imjasonh/staticmaps synced 2026-07-17 06:21:45 +00:00
Code Activity

Add doc comments for Static Map API methods

Browse source
This commit is contained in:
Jason Hall 2014-10-13 14:35:11 -04:00
parent 862c7af424
commit 556c8364df
1 changed files with 162 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

193
static.go
View file

@ -9,18 +9,35 @@ import (
)
const (
MapFormatPNG = "png"
MapFormatPNG32 = "png32"
MapFormatGIF = "gif"
MapFormatJPG = "jpg"
// MapFormatPNG requests the image in PNG format.
MapFormatPNG = "png"
// MapFormatPNG32 requests the image in PNG32 format.
MapFormatPNG32 = "png32"
// MapFormatGIF requests the image in GIF format.
MapFormatGIF = "gif"
// MapFormatJPG requests the image in JPG format.
MapFormatJPG = "jpg"
// MapFormatJPGBaseline requests the image in a non-progressive JPG format.
MapFormatJPGBaseline = "jpg-baseline"
MapTypeRoadmap = "roadmap"
// MapTypeRoadmap requests a standard roadmap image.
MapTypeRoadmap = "roadmap"
// MapTypeSatellite requests a satellite image.
MapTypeSatellite = "satellite"
MapTypeTerrain = "terrain"
MapTypeHybrid = "hybrid"
// MapTypeTerrain requests a terrain image.
MapTypeTerrain = "terrain"
// MapTypeHybrid requests a hybrid of the satellite and roadmap image.
MapTypeHybrid = "hybrid"
// SizeTiny requests a small-sized marker.
SizeTiny = "tiny"
// SizeMid requests a mid-sized marker.
SizeMid = "mid"
// SizeLarge requests a large-sized marker.
SizeLarge = "large"
)
// StaticMap requests a static map image of a requested size.
func (c Client) StaticMap(s Size, opts *StaticMapOpts) (io.ReadCloser, error) {
resp, err := c.do(baseURL + staticmap(s, opts))
if err != nil {
@ -39,6 +56,9 @@ func staticmap(s Size, opts *StaticMapOpts) string {
return "staticmap?" + p.Encode()
}
// Size specifies the height and width of the image to request in pixels.
//
// See https://developers.google.com/maps/documentation/staticmaps/#Imagesizes
type Size struct {
H, W int
}
@ -47,23 +67,88 @@ func (s Size) String() string {
return fmt.Sprintf("%dx%d", s.H, s.W)
}
// StaticMapOpts defines options for StaticMap requests.
type StaticMapOpts struct {
Center Location
Zoom, Scale int
Format, MapType, Language, Region string
Markers []Markers
Paths []Path
Visible []Location
Styles []Style
// Center specifies the location to place at the center of the image.
Center Location
// Zoom is the zoom level to request.
//
// The zoom level is between 0 (the lowest level, in which the entire world can be seen on one map)
// and 21+ (down to streets and individual buildings).
//
// Each zoom level doubles the precision in both horizontal and vertical dimensions.
//
// See https://developers.google.com/maps/documentation/staticmaps/#Zoomlevels
Zoom int
// Scale requests a higher-resolution map image for use on high-density displays.
//
// A scale value of 2 will double the resulting image size. A scale value of 4 (only available to Google Maps API for Work clients) will quadruple it.
Scale int
// Format specifies the image format to request.
//
// Accepted values are MapFormatPNG (the default), MapFormatPNG32, MapFormatGIF, MapFormatJPG and MapFormatJPGBaseline.
Format string
// MapType specifies the map type to request.
//
// Accepted values are MapTypeRoadmap (the default), MapTypeSatellite, MapTypeTerrain and MapTypeHybrid.
MapType string
// The language in which to localize labels on the map.
//
// See https://developers.google.com/maps/faq#languagesupport
Language string
// Region defines the appropriate borders to display, based on geo-political sensitivities.
//
// Accepts a two-character ccTLD ("top-level domain") value.
Region string
// Markers defines one or more markers to attach to the image at specified locations.
//
// See https://developers.google.com/maps/documentation/staticmaps/#Markers
Markers []Markers
// Path defines one or more paths to attach to the image at specified locations.
//
// See https://developers.google.com/maps/documentation/staticmaps/#Paths
Paths []Path
// Visible specifies one or more locations that should remain visible on the map, though no markers or other indicators will be displayed.
Visible []Location
// Styles defines custom styles to alter the presentation of specific features on the map.
//
// See https://developers.google.com/maps/documentation/staticmaps/#StyledMaps
Styles []Style
}
// Markers defines marker(s) to attach to the image.
type Markers struct {
Size string // tiny, mid, small
Color string // hex color, or certain color names
Label string
IconURL string
// Size defines the size of the marker(s).
//
// Accepted values are SizeTiny, SizeMid (the default) and SizeLarge.
Size string // tiny, mid, small
// Color defines the 24-bit color of the marker(s), specified as a hex string such as "#FF0033"
//
// Predefined color names are also accepted: "black", "brown", "green", "purple", "yellow", "blue", "gray", "orange", "red" and "white".
Color string
// Label specifies a single uppercase alphanumeric character to place inside the marker image.
Label string
// IconURL specifies the URL of a custom icon image to use.
IconURL string
// HideShadow, if true, will not include a shadow for the marker(s).
HideShadow bool
Locations []Location
// Locations specifies the locations of markers to be placed in this group.
Locations []Location
}
func (m Markers) encode() string {
@ -90,12 +175,32 @@ func (m Markers) encode() string {
return style + encodeLocations(m.Locations)
}
// Path defines a path to attach to the image at specified locations.
type Path struct {
Weight int
Color string // with opacity, or certain color names
FillColor string // with opacity, or certain color names
Geodesic bool
Polyline string
// Weight specifies the thickness of the path in pixels. If no weight is specified, the default is 5 pixels.
Weight int
// Color defines the 24-bit color or 32-bit (with transparency) of the path, specified as a hex string such as "#FF0033" or "#FF0033CC"
//
// Predefined color names are also accepted: "black", "brown", "green", "purple", "yellow", "blue", "gray", "orange", "red" and "white".
Color string
// Color defines the 24-bit color or 32-bit (with transparency) to fill the area of the path, specified as a hex string such as "#FF0033" or "#FF0033CC"
//
// The set of locations do not need to represent a "closed" loop; the server will automatically join the first and last points.
//
// Predefined color names are also accepted: "black", "brown", "green", "purple", "yellow", "blue", "gray", "orange", "red" and "white".
FillColor string
// Geodesic, if true, indicates that the requested path should be interpreted as a geodesic line that follows the curvature of the earth.
//
// If false (the default), the path is rendered as a straight line in screen space.
Geodesic bool
// Polyline specifies an encoded polyline of points defining the path, if Locations is not provided.
Polyline string
// Locations specifies the points of the path.
Locations []Location
}
@ -123,10 +228,20 @@ func (p Path) encode() string {
return style + encodeLocations(p.Locations)
}
// Style defines a set of rules to use to style the requested map image.
type Style struct {
Feature string // TODO enum with sub-options
// Feature specifies the feature type for this style modification.
//
// See https://developers.google.com/maps/documentation/staticmaps/#StyledMapFeatures
Feature string // TODO enum
// Element indicates the subset of selected features to style.
//
// See https://developers.google.com/maps/documentation/staticmaps/#StyledMapElements
Element string // TODO enum
Rules []StyleRule
// Rules specifies the style rules to apply to the map.
Rules []StyleRule
}
func (t Style) encode() string {
@ -143,13 +258,29 @@ func (t Style) encode() string {
return strings.Join(s, "|")
}
// StyleRule defines a style rule to apply to the map.
type StyleRule struct {
Hue string // rgb color
Lightness float64 // -100 to 100
Saturation float64 // -100 to 100
Gamma *float64 // .01 to 10, default 1
// Hue is the hue value, as a hex string (e.g., "#FF00EE") to apply to the selection.
Hue string // rgb color
// Lightness (a value between -100 and 100) indicates the percentage change in brightness of the element. -100 is black, 100 is white.
Lightness float64
// Saturation (a value between -100 and 100) indicates the percentage change in intensity of the basic color to apply to the element.
Saturation float64 // -100 to 100
// Gamma (a value between 0.01 and 10.0, where 1.0 applies no correction) indicates the amount of gamma correction to apply to the element.
Gamma *float64 // .01 to 10, default 1
// InverseLightness, if specified and true, inverts the Lightness value.
InverseLightness *bool
Visibility string // on, off, simplified
// Visibility indicates whether and how the element appears on the map.
//
// A value of "simplified" indicates that the map should simplify the presentation of those elements as it sees fit.
//
// Accepted values are "on", "off" and "simplified"
Visibility string // TODO: enum
}
func (r StyleRule) encode() string {