Map.show Function

Format

b = map_name.show();

Description

The Map.show function displays the Map object named map_name. The function call replaces the active view (generally either a question or a different map) and displays the map. The map will continue to be displayed until the user taps on the back button or the Map.hide function is called from within a callback function.

The Map.show function will not finish execution until the user has finished interacting with the map. For this reason, you should do all initial map setup (adding markers, buttons, base map, etc.) before calling Map.show. If any map functions are given after the call to Map.show, they will not be executed until after the map has been hidden. You can, however, make modifications to the map while it is showing from logic in a callback function supplied to one of the map functions such as Map.setOnClick, Map.addTextButton, Map.addImageButton, Map.setMarkerOnClick, Map.setMarkerOnClickInfoWindow, or Map.setMarkerOnDrag.

Return Value

The function returns a logical value of 1 (true) if the map was shown successfully and 0 (false) if there was an error.

Example

PROC GLOBAL

// User function that will be called on button click
// to close the map
function closeMap(Map m)
m.hide();
end;

PROC SOMEITEM

// Declare a map
Map mymap;

// Add a button to the map that closes the map when it is clicked
mymap.addTextButton("close", closeMap(myMap));

// Show the map; this function will keep running until the user clicks
// the close button or uses the back button to exit the map
mymap.show();

// This logic is only run AFTER the call to hide
errmsg("Done showing map");

See also: Map Object, Map.hide Function