Multimap API v1.1 Documentation

The Multimap API offers programmatic access to best-of-breed location services, allowing you to build highly interactive web sites. Before you start building your applications, we advise you to read this document first before moving on to the examples below.

• Hello World! Example
This simple example gives an overview of the HTML that makes up each page and displays a map centered on Fleet Street, London. It does not give any information regarding zoom factors or operating the map. It explains the makeup of the page, including linking to the map viewer API using a single JavaScript line, and having a container ready to take the map viewer. This page explains the HTML code but not the JavaScript.
• The Basics
This page describes what the JavaScript in the previous page did and how to create a map viewer, passing in a reference to the map viewer DIV. This example draws the map at a different zoom factor.

Functions used: MultimapViewer() drawAndPositionMap()

• Browser Compatibility Test Page
This demonstrates a page redirect when a browser does not have JavaScript enabled or when the browser is not supported by the API. When the page is viewed using a compatible browser the page should show a map; when the browser is not compatible it should redirect to a page with a message to the user.

Functions used: MMIsSupportedBrowser()

• Map Movement and Animation
This page explains how moving the map works from the code level. It offers buttons that move the map to a variety of locations and demonstrates how, if a move is within the viewer, the map pans smoothly to the new location; if it is not, the images are replaced.

Functions used: moveMap() resetPosition() goToPosition() moveMapMetres()

• Zoom Example
This describes the concept of zoom factors. It gives examples of use of the zoom factor functions, and provides information about the mouse wheel zoom.

Functions used: setZoomFactor() getZoomFactor() zoom() getAvailableZoomFactors()

• Adding Widgets to the Map - (Pan, Zoom Controls)
This explains about widgets and their use and gives a list of widgets currently available. It offers buttons to add and remove one of each type of widget.

Functions used: addWidget() removeWidget MMPanZoomWidget() MMSmallPanZoomWidget() MMSmallZoomWidget()

• Markers
This gives an example of placing markers on the page, including custom markers.

Functions used: createMarker() removeAllOverlays()

• Opening an Info Box
This section shows how to place info boxes on the page, and how to put basic content within boxes; it also shows how to place more advanced content such as forms or pictures.

Functions used: createInfoBox() removeOverlay() removeAllOverlays()

• Event Handlers
This gives an overview of the event handlers system with examples of every type of event available.

Functions used: addEventHandler() removeEventHandler()

• Info boxes above markers
This shows how to display an info box above a marker easily by clicking on it.

Functions used: createMarker() openInfoBox() addEventHandler()

• Geocoding - Basic example
This example shows the simplest way of combining the Mapping and Geocoding functionality of the Multimap API, including the use of the events startGeocode and endGeocode.

Functions used: MultimapViewer() drawAndPositionMap()

• Geocoding - Using the Multimap API Geocoder
This example shows how to work directly with Geocoding functionality of the Multimap API. It shows how to work directly with the MMGeocoder class, including the handling of multiple results from the geocoder.

Functions used: geocode()

• Copyright Bar Example
This page demonstrates how the scale and copyright bar change as a map is moved. Starting at Dover, United Kingdom, it moves the user down toward Calais, France.

Functions used: goToPosition() moveMap()

• "No Data" Image Test
This demonstrates that, at certain points, a "no data" image is visible where map coverage is not currently available.

Functions used: goToPosition()

• Get Map Properties Examples
This offers buttons to see various properties of the map, such as bounds, width, height and current position.

Functions used: getMapBounds() getCurrentPosition() getDimensions()

• Disabling Dragging
This demonstrates that dragging can be disabled and enabled.

Functions used: setDraggable() getDraggable()

• Keyboard Panning
This demonstrates that the cursor keys may be used to navigate the map and shows how diagonal panning can be achieved.

Functions used: setKeyboardPanning() getKeyboardPanning()

• Pan Limiting
This demonstrates a method of using the API's features to prevent users from being able to pan outside a specified area.

Functions used: addEventHandler() getCurrentPosition() getSmoothPanning() setSmoothPanning() goToPosition()

• Re-styled Info Box
This demonstrates a completely re-styled info box.

Functions used: createInfoBox()

• Advanced Widgets
This demonstrates all types of widgets, and how to place widgets differently by passing in a different offset; it also shows how to re-style a widget.

Functions used: addWidget() removeWidget()

• Making XML Requests
This demonstrates a method of integrating XML with a map using XMLHTTPRequest.

Functions used: getXMLHTTPRequest()

• JSON Storefinder
This demonstrates a method of integrating the API with the Multimap JSON Storefinder service. It shows how to make JSON requests by adding a script tag to the page.

Further Help

Customer Support

For support queries during office hours, please contact your nearest Multimap Support team:

Australia, Sydney	+ 61 (0) 2 9262 6551
Great Britain, London	+44 (0)20 7632 7777
United States, Boston	+ 1 617 423 4510
email:	info@multimap.com

For general account enquiries or further services, please contact your Multimap Sales team:

Australia, Sydney	+ 61 (0) 2 9262 6551
Great Britain, London	+44 (0)20 7632 7800
United States, Boston	+ 1 617 423 4510
email:	sales@multimap.com