| 1 |
GMAP-MACRO-DICTIONARY.txt
|
| 2 |
This file defines the attributes available in GMap macros.
|
| 3 |
|
| 4 |
----------------
|
| 5 |
BASIC ATTRIBUTES
|
| 6 |
----------------
|
| 7 |
|
| 8 |
Attribute: center
|
| 9 |
Values: lat,lon
|
| 10 |
Description: map center
|
| 11 |
Example: center=39.36827914916013,-81.5625
|
| 12 |
|
| 13 |
Attribute: width
|
| 14 |
Values: css dimension
|
| 15 |
Description: map width, in valid css dimensions (generally pixels or percent)
|
| 16 |
Example: width=100%
|
| 17 |
|
| 18 |
Attribute: height
|
| 19 |
Values: css dimension
|
| 20 |
Description: map height, in valid css dimensions (generally pixels)
|
| 21 |
Example: height=400px
|
| 22 |
|
| 23 |
Attribute: zoom
|
| 24 |
Values: 0-17
|
| 25 |
Description: the initial zoom level of the map
|
| 26 |
Example: 7
|
| 27 |
|
| 28 |
Attribute: type
|
| 29 |
Values: "Map", "Satellite", "Hybrid", "Terrain"
|
| 30 |
Description: baselayer
|
| 31 |
Example: type=Map
|
| 32 |
|
| 33 |
Attribute: control
|
| 34 |
Values: "None", "Large", "Small"
|
| 35 |
Description: zoom and pan controls
|
| 36 |
Example: control=Small
|
| 37 |
|
| 38 |
Attribute: align
|
| 39 |
Values: "Right", "Left", "Center"
|
| 40 |
Description: alignment of map on page
|
| 41 |
Example: align=Center
|
| 42 |
|
| 43 |
Attribute: id
|
| 44 |
Values: id attribute name
|
| 45 |
Description: id for the rendered map element, to distinguish the map from other maps on the same page. Any controls that are synced with the map require a map id.
|
| 46 |
Example: id=mymap
|
| 47 |
Notes: use if you need to access the map from a script, or if you plan to have multiple maps on a page. As of Gmap 1.0, this is no longer required.
|
| 48 |
|
| 49 |
--------
|
| 50 |
OVERLAYS
|
| 51 |
--------
|
| 52 |
Each of these attributes may be repeated within a GMap macro. You would repeat attributes if you wanted multiple overlays of the same type on one map.
|
| 53 |
|
| 54 |
Attribute: markers
|
| 55 |
Values: marker name::lat1,lon1:popup1 text + lat2,lon2:popup2 text + … + latN,lonN:popupN text
|
| 56 |
Description: place a point or series of points on the map
|
| 57 |
Example: markers=blue::39.367383358933125,-81.56906604766846 + 39.36675298114445,-81.5561056137085
|
| 58 |
Notes: Repeat for each different marker type that you want to use. The "marker name" may be the name of a series of markers. Popup text may contain plain text or HTML, as long as it does not have the symbols "|", "+", or "]". Use the HTML entities for these characters (|, +, and ] respectively).
|
| 59 |
|
| 60 |
Attribute: feed
|
| 61 |
Values: GeoRSS feed
|
| 62 |
Description: an RSS feed with geo:lat information to be overlaid on the map. **local feeds only?
|
| 63 |
Example: feed=blue::/my-location-rss
|
| 64 |
Notes: Location.module automatically adds GeoRSS information to RSS feeds. This means that RSS feeds created with Views can be directly overlaid onto your GMaps.
|
| 65 |
|
| 66 |
You can set some style attributes for lines and shapes. Where these are not set, the defaults for google are used. These styles are written directly after the "=" in a specific order, separated by a "/", and are followed by a ":". Previous versions of GMap could use Xmaps to create dashed lines and text labels for lines and polygons, but those options are no longer supported. Opacity also used to be specified as a number between 0 and 1; it is now a number between 0 and 100.
|
| 67 |
|
| 68 |
Attribute: line
|
| 69 |
Values: line color in hex/line width in pixels/line percent opacity:lat1,lon1 + lat2,lon2 + … + latN,lonN
|
| 70 |
Description: place a line on the map
|
| 71 |
Example: line=#0000ff/5/45:39.361942015870724,-81.5711259841919 + 39.369506694882396,-81.56558990478516 + 39.3664212010754,-81.56172752380371 + 39.368146440221935,-81.55773639678955
|
| 72 |
Notes: It is best to break up long lines into shorter segments, because long lines can be buggy--sometimes beginning and ending points are switched.
|
| 73 |
|
| 74 |
Attribute: circle
|
| 75 |
Values: line color in hex/line width in pixels/line percent opacity/fill color in hex/fill percent opacity:lat1,lon1 + lat2,lon2 + … + latN,lonN
|
| 76 |
Description: place a circle on the map
|
| 77 |
Example: circle=#000000/3/25/#ffff00/45:39.37395222041742 , -81.56816482543945 + 0.7622248729082767 |markers=big blue::47.040182144806664,-90 + 39.36827914916013,-81.5625 + 39.36827914916013,-81.5625
|
| 78 |
Notes: if you draw a large circle on the map, it will not appear as a perfect circle--2D maps of the globe are necessarily distorted.
|
| 79 |
|
| 80 |
Attribute: polygon
|
| 81 |
Values: line color in hex/line width in pixels/line percent opacity/fill color in hex/fill percent opacity:lat1,lon1 + lat2,lon2 + … + latN,lonN
|
| 82 |
Description: place a filled polygon on the map
|
| 83 |
Example: polygon=#000000/3/25/#ff0000/45:39.37202807246466,-81.56992435455322 + 39.373686823852424,-81.55782222747803 + 39.37099962681384,-81.55486106872559 + 39.37046881022853,-81.56636238098145 + 39.37202807246466,-81.56992435455322 |markers=big blue::47.040182144806664,-90 + 39.36827914916013,-81.5625 + 39.36827914916013,-81.5625
|
| 84 |
|
| 85 |
Attribute: rpolygon
|
| 86 |
Values: line color in hex/line width in pixels/line percent opacity/fill color in hex/fill percent opacity: center lat,center lon + vertex lat,vertex lon + num sides
|
| 87 |
Description: place a filled regular polygon on the map
|
| 88 |
Example: rpolygon=#000000/3/25/#ff0000/45:44.20583500104184,-70.367431640625 + 44.315987905196906,-68.609619140625 + 4
|
| 89 |
|