Map.setOnClick Function

Format

b = map_name.setOnClick(callbackFunction);

Description

The Map.setOnClick function sets the function that is called when the user taps on the base map away from any markers. The callbackFunction is the name of a user function defined in the global procedure that will be called when the user taps on the map. The function name may optionally be followed by function arguments which will be passed to the function when it is run. These arguments are evaluated at the time that Map.setOnClick is called rather than at the time the callback is run.

To retreive the coordinates of the map location that was tapped, use the functions Map.getLastClickLatitude and Map.getLastClickLongitude.

If the user taps on a marker rather than on the map itself, callbackFunction is not called. To capture taps on markers use the Map.setMarkerOnClick function.

Return Value

The function returns a logical value of 1 (true).

Example

PROC GLOBAL

// Declare a map
Map mymap;

// Declare id for map marker
numeric markerId;

// This function is called when user taps on map.
// It moves the marker to the location that the user tapped.
function mapClicked()
numeric lat = mymap.getLastClickLatitude();
numeric lon = mymap.getLastClickLongitude();
mymap.setMarkerLocation(markerId, lat, lon);
end;

PROC SHOW_MAP
preproc

// Add a marker to the map at latitude 38.84839, longitude -76.931098
markerId = mymap.addMarker(38.84839, -76.931098);

// Set function that is called when the user taps on the map to move the marker
// to the new position
mymap.setOnClick(mapClicked());

// Display the map
mymap.show();