Multimap API V1.2 JavaScript Example

Searching - Combining Features of the Multimap API Searching Module *new*

The Multimap API now allows you to make a search of the records that have been geocoded and stored in the table of addresses that we provide as part of your your Multimap service, and to display on a map the locations that the table contains.

You should manage your table of addresses through Multimap's Client Zone extranet portal; please see your Multimap service documentation for details of how to use this.

Searches can be based on spatial criteria, non-spatial criteria or a combination of both:

• spatial searches are based on location (such as 'Where's my nearest...?' or 'What's within the area...?'); and
• non-spatial searches are based on non-location criteria such as name, categories, value or size.

What You Should See

If you view this in your browser you should see a Multimap draggable map centered on Fleet Street, London, Great Britain, at zoom factor 15.

To the right of the map is a column of data entry fields into which you can enter selection criteria to search your data and filter the results.

Please note that the effects of all these selection criteria are cumulative; if you select criteria on which to filter your data, a record appears in your list of results only if it matches all the criteria you have set.

• If you enter an address in the "Address" field, the Multimap API attempts to geocode that address before performing a search.
• If you click on the "Restrict searching to bounds of map" checkbox, the Multimap API attempts to match only those address records located within the area that is visible on the map; it disregards all other possible results outside the bounds of the map, regardless of whether those records match any other selection criteria.
• You can use the "Min distance" and "Max distance" options to restrict the area of your search to within two variable radii. In this example this is set to miles, but you can use kilometers if you prefer; please see the separate topic on Options for details.
• You can use the "Result set size" option to specify the total number of possible results you wish the API to return.
• You can use the "Count" option to specify the number of possible results you wish each page to display.
• You can use the "Start index" option to determine the number of the first record in your result set that you wish to show on your map: markers are incremented from this record upwards. For example, if you wish to show numbered markers for your 21st record upwards, select "21" from this drop-down list. (Please note that, to ensure correct behavior of the "Start index" and "Result set size" controls, the value of "Start index" should not exceed that of "Result set size".)
• You can use the "Order" options to specify whether your results are listed in order of proximity, duration or name, and in ascending or descending order.
• You can use the "Filter results by" drop-down lists and text box to specify a further selection criterion, dependent on matching a value in the text box against a record in your database:
  • the first drop-down list controls the name of the database field whose value you wish to check; and
  • the second drop-down list determines the operation by which you wish to evaluate your selected database field against the value that you enter in the text box below.
• Please note that the like operator uses 'wildcard' characters to match patterns, so that, for example, "like *tim*" equates to "contains tim".

When you click on the "Search" button, the map changes to show all possible matching search results on the map as markers; a list of their locations appears below the map. For example, if you select a "Result set size" of 100, a "Count" of 20, and a "Start index" of 51, the page displays records 51 to 70 of 100 possible records. (If no results are found, or if any other problem occurs, the API displays a message to this effect.)

When you click on any of the results in the list, its marker on the map expands to show its details in an info box.

'Logging' selection of markers

Please see the corresponding section of the topic on non-spatial searching.

The Map

Messages and results will be placed here

The Code

There are four parts to the code below. The first is the line that links to the Multimap API. The second is an example of the HTML you must have in your page. The third is an example of the JavaScript required to implement the page. Finally, the fourth is the CSS code that you should add to your web page.

The header code

<script type="text/javascript" src="http://clients.multimap.com/API/maps/1.2/demo"></script>

The body code

Sorry, JavaScript required...

Sorry, JavaScript required...

Sorry, JavaScript required...

The JavaScript code

Sorry, JavaScript required...

The CSS code

Sorry, JavaScript required...

For more information on the subject of Multimap API JavaScript code, please read the API documentation at: http://clients.multimap.com/share/documentation/api/1.2/classes/.

Back to examples.

Preview and Live Environments

The Multimap API allows you to upload your store data via Multimap's Client Zone extranet and test it in a preview environment before making the data live. To view your preview data on a web page similar to this one, specify

<script type="text/javascript" src="http://preview.multimap.com/API/maps/1.2/demo">

instead of

<script type="text/javascript" src="http://clients.multimap.com/API/maps/1.2/demo">

in the <HEAD> section of your web page.

For further details of your preview and live environments, please see Multimap's separate Geocoding and Data Management in Client Zone: Implementation Guidelines / Software Development Kit (SDK) documentation.