A Google map. To use this control, you must configure the control's key property with a valid Google Maps API key. For more information, see Google Maps API Family. When registering a key, you must specify the host name and port number of the server. Use the host name and port number the user can see in the browser address bar when accessing the portlet or Web application. For example, if the user accesses the application using http://mws.example.com/, you need to use http://mws.example.com/ when registering for a key.

If the map is not rendered during the initial page load, that is, if the map is rendered only as part of an async refresh and not as part of the initial page, you must include a Google Map Key control as part of the initial page, configured with the Google Maps API key. Otherwise, you can ignore the Google Map Key control.

The center of the map is specified using the latitude and longitude property values. You can also specify the center of the map as follows:

• The map's initialAddress property, if the latitude and longitude are both set to 0. You can format the address as a natural-language address; you can concatenate multiple lines into a single line with spaces, for example, 600 108th Ave NE, Bellevue, WA 98004 USA. You can specify a two-letter ISO-3166 country code using the initialCountry property as a country/locale hint, though it is generally not needed.
• Auto-centering among the map's initial markers, if the map's latitude and longitude are both set to 0, its initialAddress is blank, and the map has markers.

You can add a variety of controls to the Google Map control:

• Use the Map Navigation Control to add map navigation controls such as a zoom control, and a map type control.
• Use Map Marker children of a Map Marker Group control to add individual markers to the map.
• Use a Dynamic Map Marker List control to add a list of markers from a dynamic data source such as an array of rows from a SQL result set or an array of items from a Web service result to the map.

Scripting

The Google Maps API is a full-featured, client-side JavaScript API, and is fully accessible for use with the CAF Google Maps controls.

To access the GMap2 object, the Google Maps API map object, associated with a Google Map control, use the map property of the control's CAF client-side model object. The following example looks up the GMap2 object of the Google Map control model with an ID of myMap, and uses the Google Maps API to zoom in one level:

var map = CAF.model("#{caf:cid("myMap")}").map;
map.zoomIn();

Client-Side Model

The CAF client-side model object for the Google Map control extends from the CAF.Input.Model object. For more information, see information about the client-side model see "Client-Side Model" in the webMethods CAF Development Help.

The value of the model object is the coordinates of the map's center in String form, for example, 37.0625;-95.67706. The following script centers a Google Map control with an ID of myMap over the city of Bellevue, Washington:

CAF.model("#{caf:cid("myMap")}")
     .setValue("37.0625;-95.677068");

The CAF.GMap.stringToGLatLng() and CAF.GMap.gLatLngToString() functions convert string coordinates to and from a GLatLng object, the Google Maps API coordinates object.

You can also use the CAF client-side model to set a map's center with a natural-language address. The following script centers a Google Map control with an ID of myMap over the city of Bellevue, Washington:

CAF.model("#{caf:cid("myMap")}")
     .setAddress("600 108th Ave NE, Bellevue, WA 98004");

You can also auto-center a map among the map's markers with the client-side model's autoCenter() method. The following script centers a Google Map control with an ID of myMap among the markers on the map:

CAF.model("#{caf:cid("myMap")}").autoCenter(true);

Pass a value of true to the autoCenter() method to automatically zoom so that all markers on the map are visible; pass a value of false or nothing to auto-center without changing the zoom level.

Script Controls

You can also use the standard Script-category controls like Return Value Script or Invoke Script to manipulate the map with the standard client-side actions, such as getValue or setValue. You can also use the custom Return Map Value Script and Invoke Map Script controls to access special map-only properties and actions, such as getLatitude or setAddress. The Return Map Coords Script control enables specifying the latitude and longitude coordinates when invoking the setValue or setCoords action.

Children

Map Navigation control, Dynamic Map Marker List control, Map Marker Group control, or Invoke Map Script control