Configuration options
You can show your myGeoBook data using an embedded map which can be configured to show prefered zoom levels, search options and much more. The various options are explained below.
Sample map:
Base embedded map URL:
http://mgbembeddedmap.mygeobook.com/Map.aspx
Parameter rules
- you use the embedded map parameters in the same way you would use URL parameters for a web page. Example: embedded_map_base_URL?param1=val1¶m2=val2...paramN=valN
- any parameter is optional unless explicitly specified as mandatory
- the order in which the parameters are written is not important
Parameters
- profileId - the id of the profile to be loaded on the map. You can also specify a list of profiles separating the ids by comas. Examples: profileId=1069 or profileId=1069,1082
- mapStyle - represents the style of the map. Only applies when the Bing map engine is used. Valid values are: road, aerial and hybrid (aerial including labels). Default value is road. Example: mapStyle=road
- autoZoomAndCenter - boolean flag (allows only the true or false values) which specifies if the embedded map should auto center and zoom on the displayed profiles. Default value is true. Example: autoZoomAndCenter=false
- zoom - the zoom level to be used by the map. The value is dependent on the map engine. For Bing maps the zoom values must be integers from 1 (max zoom out) to 19 (max zoom in). To prevent the embedded map from rezooming when loading the profiles, set the autoZoomAndCenter to false. Example: zoom=5 or autoZoomAndCenter=false&zoom=6
- centerLat and centerLon - the GPS coordinates for the point where you want to center the map. You supply either both values, either none. To prevent the embedded map from applying automatic zoom and center behavior, set the autoZoomAndCenter parameter to false. Examples: centerLat=51.4¢erLon=0&autoZoomAndCenter=false&zoom=8
- centerPoiId - the id of the MGB Point of Interest on which to center the map. To prevent the embedded map from applying automatic zoom and center behavior, set the autoZoomAndCenter parameter to false. Examples:centerPoiId=481&profileId=1085&autoZoomAndCenter=false&zoom=6
- showSearch - displays the search control for performing full text search on the map POIs. The default value is false. Example: showSearch=true
- centerByIp - if set to true the embedded map will be centered on the location given by the user's current IP address. The default value is false. If this parameter is set to true, the following parameters will be ignored: autoZoomAndCenter, centerLat, centerLon. Example:
centerByIp=true
- mgbStyle - posible values: map, list. Allows the user to choose the way points of interest are displayed. In map mode, the points are displayed on a map, in list mode they are displayed inside a paginated list. Default value: map.
- showListLink - if true, a link to the list view mode of the map will be displayed. If the control is in list mode, a link to the map view mode will be displayed. Default value: false.
Examples:
http://mgbembeddedmap.mygeobook.com/Map.aspx?profileId=1069
http://mgbembeddedmap.mygeobook.com/Map.aspx?centerPoiId=1545&profileId=1194&autoZoomAndCenter=false&zoom=12