Instructions for Integrating
Maptech's MapServer Into Your Site.

The standard Maptech MapServer can be integrated into your web site through the use of a regular browser window, a pop-up browser window or within a frameset using your existing web page layout.

For advanced web developers we have an Advanced MapServer Application Programming Interface (MapServer API), that provides the ability to build and control their own graphical web page mapping interface. For more information on the Advanced MapServer API, please jump to the Advanced Maptech MapServer API sections below.

The MapServer is controlled via its URL and associated parameters as described below.   These parameters allow you to select the map type, the location of the center of the map, scale, zoom, and the ability to place a location icon.

You can use the detailed information provided on this page to control the MapServer OR you can simply use the MapServer to create the map views that you require by copying  the corresponding URLs from your browser's address bar (as it displays the maps you need), then pasting those URLs into your web pages as hyperlinks.

Please bookmark this page for future reference!
Otherwise you will have to go through the sign up procedure again.

  Powered By MAPTECH MapServer - Buttons for your site
  Linking to the MapServer
  MapServer Parameter Syntax
  Syntax Examples
  Advanced MapServer API - Include
  Advanced MapServer API - Settings
  Advanced MapServer API - With Multiple Icons
  Additional Notes
  Special Characters

Related Pages:
  MapServer Getting Started Tutorial - learn how to use the MapServer
  About My Maps - learn how location maps can enhance your web site
  More About Maps and Charts - learn about our 65,000+ maps and charts

 

| MapServer Home | Maptech Home |

CONFIDENTIAL AND PROPRIETARY INFORMATION
Copyright 2000 - 2009 Maptech, Inc., All Rights Reserved.

 


Powered By MAPTECH MapServer
- BUTTONS FOR YOUR WEB SITE


These "Powered By" buttons are provided for your use. If you wish to use them on your site, simply copy them, and utilize them as described below. If you wish to design your own, you must include the Maptech logo and the terminology "powered by Maptech" or "powered by Maptech MapServer".


LINKING TO THE MAPSERVER

You can link your web site to the MapServer in several ways, the most common of which are (1) opening the MapServer in a currently opened browser window with a simple HREF link,
(2) opening the MapServer in a pop-up window, and
(3) opening the MapServer in a frameset. 

Examples of Possible MapServer Implementations

Simple HREF Link

To create a link to the MapServer:

<!-- simple href -->
<A HREF=”http://mapserver.maptech.com/bp/mapserver/index.cfm”>
Maptech MapServer</A>

The specific location, type of map, scale, and zoom of the display can be controlled by appending any of the parameters and settings described in the following section.  

Note that in the example HREF link below, since no latitude and longitude are specified, the MapServer opens at a default location.

click here for an example of an HREF link implementation

back to top 

MapServer in a Pop-Up Window

To display the MapServer in a pop-up window:

<html>
  <head>
    <title>Sample Pop-Up Window</title>
      <SCRIPT LANGUAGE="JavaScript">
       <!-- Pop Up MapServer Window
       function popMSRV() {
            var wnam = 'MapServerWin';
            var attr = 'toolbar=no,location=no,directories=no,
            status=no,menubar=no,scrollbars=yes,resizable=yes,
            copyhistory=no,width=540,height=700';
            var loca ='http://mapserver.maptech.com/bp/
            mapserver/index.cfm';
            window.open(loca, wnam, attr);
       }
       //-->
    </SCRIPT>
  </head>
  <body>
    
<A HREF="JavaScript:popMSRV();">Click here for an example
     pop-up window implementation</A>
  </body>
</html>

The specific location, type of map, scale, and zoom of the display can be controlled by appending any of the parameters and settings described in the following section.

Note that in the first example implementation link below, since no latitude and longitude are specified, the MapServer opens in a special mode that prompts the user to "enter a city, town, or place name and select a state".

example implementation of the above code

example pop-up window implementation at defender.com

back to top 

MapServer in a Frameset

To embed the MapServer into a frameset:

<html>
   <head>
   <title>Sample Frameset</title>
   </head>
   <!-- Frames -->
   <FRAMESET rows="90,*">
      <FRAME NAME="Header" SRC="my_header.htm" 
      MARGINWIDTH="10" MARGINHEIGHT="10" 
      SCROLLING="no" FRAMEBORDER="0">
      <FRAME NAME="MapServer"
      SRC="http://mapserver.maptech.com/bp/
      mapserver/index.cfm" MARGINWIDTH="10"MARGINHEIGHT="10"
      SCROLLING="auto" FRAMEBORDER="0">
   </FRAMESET>
</html>

The specific location, type of map, scale, and zoom of the display can be controlled by appending any of the parameters and settings described in the following next section.

Note that in the first example implementation link below, since no latitude and longitude are specified, the MapServer opens in a special mode that prompts the user to "enter a city, town, or place name and select a state".

example implementation of the above code

example frameset implementation at boatscape.com 

back to top 

MAPSERVER PARAMETER SYNTAX

The MapServer is controlled through a number of URL parameters as described below.  These parameters control (1) the latitude and longitude of the map image; (2) the type of map, chart or navigation photograph; (3) the map scale; (4) display zoom, and (5) the location map icon, if any.

MapServer Parameter Syntax:

http://mapserver.maptech.com/bp/mapserver/index.cfm?
lat=latitude_value&lon=longitude_value&type=type_of_image&
scale=scale_of_map&zoom=zoom_level&bpid=business_partner_ID&
icon=icon_name|icon_latitude|icon_longitude|icon_url|icon_title&

lat=latitude_value

Latitude of origin (center point of map image), decimal degrees; float

Example: to display a map vertically centered at longitude 43.32678N, use "lat=43.32678"

Notes: Required.  Sign conventions - Southern hemisphere latitude coordinates are denoted with a minus sign (0 to -90).  Northern hemisphere latitude coordinates are positive and denoted without a plus sign (0 to 90).  Must be used with corresponding Lon value.

back to top 

lon=longitude_value

Longitude of origin (center point of map image), decimal degrees; float

Example: to display a map horizontally centered at longitude 118.32435W, use "lon=-118.32435"

Notes: Required.  Sign conventions -  Western hemisphere longitude coordinates are denoted with a minus sign (0 to -180).  Eastern hemisphere longitude coordinates are positive and are denoted without a plus sign (0 to 180).  Must be used with corresponding Lat value.

back to top 

type=type_of_image

Type of image to be displayed (topographic map, nautical chart, aeronautical chart or navigation photo); integer {0=nautical chart, 1=topographic map, 2=aeronautical chart, 3=navigation photo} 

Example: to display a topographic maps, use "type=1"

Notes:  If "type" is not specified, the MapServer will default to type=1, a topographic map.  In cases where no data is available for a specified lat/lon, the text message "no data available" will appear for types 0 (nautical charts), 2 (aeronautical charts), and 3 (navigation photos).  A blank image will be displayed for type 1 (topo maps).

more about maps and charts available on the MapServer

back to top 

scale=scale_of_map

Scale of chart or map to be displayed; integer.

Example: to display a 1:100,000 scale map, use "scale=100000"

Notes: If the requested scale is unavailable, then the closest available scale is chosen. The scale values refer to the scale of the corresponding paper map or chart.  Note that the actual display scale of the image on a computer monitor will usually not match the paper map or chart scale.  This is due to variations in the resolution at which the map or chart was scanned, the resolution of the computer monitor and video display adapter, and the zoom level at which the map or chart is being viewed.

more about scale

back to top 

zoom=zoom_level

Zoom level of map or chart to display; integer {50,100} 

Example: to display a map at 50 percent zoom, use "zoom=50"

Notes: Nautical charts look best displayed at a zoom of 50%.  Topo maps look best at 100%.

more about zoom

back to top 

bpid=business_partner_ID 

Used by Registered MapServer Business Partners Only.  If you are a registered MapServer Business Partner your BPID must be typed into the URL exactly (as shown below) for each and every link made to the MapServer from your website. Your links can also point to any page in any directory on www.maptech.com, provided that the file has a .cfm extension.

Example:
http://mapserver.maptech.com/bp/mapserver/index.cfm?bpid=
MAP0060030900

Product Page Example:
http://www.maptech.com/water/chartkitbooks/index.cfm?bpid=
MAP0060030900

back to top 

icon=location_icon

Start of optional location icon. 

Example: See below

Notes: If no icon is to be displayed then use &Icon=0&.

more about location icons and the My Maps feature

back to top 

icon_name

Alphanumeric text string that corresponds to an icon image .gif file.  

Example: &icon=AnimArrowRotates_red_32_32_-32_-16

Notes: The icon name does not include the ".gif" extension.  A current list of available icons and their file names may be found here.

back to top 

icon_latitude

Latitude in decimal degrees where the icon will be drawn on the map image.  Required.

Example: |44.8020

Notes: Southern hemisphere latitude coordinates are denoted with a minus sign (0 to -90).  Northern hemisphere latitude coordinates are positive and denoted without a plus sign (0 to 90).

back to top 

icon_longitude

Longitude in decimal degrees where the icon will be drawn on the map image. Required.

Example: |-68.7704

Notes:  Western hemisphere longitude coordinates are denoted with a minus sign (0 to -180).  Eastern hemisphere longitude coordinates are positive and are denoted without a plus sign (0 to 180).

back to top 

icon_url

URL that will be linked to the icon. Optional.

Example: |http://www.landvest.com/fine_homes

Notes: The connected web page will be displayed in a new browser window.  The url must be complete and include "http://".  Although the URL link is optional, we recommend that you always include one in order to provide a predictable user interface.  If no URL is to be used, then don't put anything between the pipe sign delimiters ("||").  The icon_url  MUST be url encoded: See notes below about use of special characters in a URL.

back to top 

icon_title

Title alphanumeric text string to be displayed with icon.  Optional.

Example: |^Harbor Ledge Estate, Northeast Harbor

Notes: As a default the title will become visible as a tool-tip when the users curser hovers over the icon. Alternatively, the title can be displayed in and "on" mode next to the icon by placing a "^" as the first character of the title text.  The title may be up to a maximum of 20 characters.

back to top 

SYNTAX EXAMPLES


http://mapserver.maptech.com/bp/mapserver/index.cfm?
lat=42.972818&lon=-71.981756&type=1&zoom=100&scale=24000&
icon=houseforsale_red_64_64_-64_-64|42.972818|-71.981756|
http%3A%2F%2Fwww%2Ethemollers%2Ecom%2F|
^The Moller's Inc. 

click here to view the above example

http://mapserver.maptech.com/bp/mapserver/index.cfm?
bpid=
MAP0060030900&lat=44.7483059685&
lon=-68.8291797973&type=3&zoom=100&scale=20000&
icon=building_red_32_32_-16_-16|44.7483059685|-68.8291797973||
Palmer/Jadkowski Family with name in tool tip and no Web Site link

click here to view the above example

Advanced MAPSERVER API - INCLUDE

The Advanced MapServer Application Programming Interface (MapServer API) provides advanced web developers with the ability to build and control their own graphical web page mapping interface as well as the ability to display multiple icons on maps, charts, and photos. Compatible with most server-side scripting languages including Cold Fusion, ASP, and PHP, the Advanced MapServer API is available to registered Business Partners.

Advanced MapServer API pricing starts at $10,000 per year (standard "linking" to the MapServer is free). Contact ddonovan@maptech.com for more information.

back to top 

Advanced MAPSERVER API - SETTINGS

The Advanced MapServer Application Programming Interface (MapServer API) provides advanced web developers with the ability to build and control their own graphical web page mapping interface as well as the ability to display multiple icons on maps, charts, and photos. Compatible with most server-side scripting languages including Cold Fusion, ASP, and PHP, the Advanced MapServer API is available to registered Business Partners.

Advanced MapServer API pricing starts at $10,000 per year (standard "linking" to the MapServer is free). Contact ddonovan@maptech.com for more information.

back to top 

Advanced MAPSERVER API - USING MULTIPLE ICONS

The Advanced MapServer Application Programming Interface (MapServer API) provides advanced web developers with the ability to build and control their own graphical web page mapping interface as well as the ability to display multiple icons on maps, charts, and photos. Compatible with most server-side scripting languages including Cold Fusion, ASP, and PHP, the Advanced MapServer API is available to registered Business Partners.

Advanced MapServer API pricing starts at $10,000 per year (just "linking" to the standard MapServer is free). Contact ddonovan@maptech.com for more information.

back to top 

ADDITIONAL NOTES

As of June 2002 older browsers are not powerful enough to work properly with all functions of the new and improved Maptech MapServer. Users with older browsers will be unable to use the MapServer.
Older browsers are not in compliance with current W3C coding standards. W3C sets the benchmarks for web standardization.

We at Maptech have redesigned our new MapServer to work with those browsers that most closely adhere to W3C standards. Here's a partial list of those browsers.

Microsoft Internet Explorer 4
Microsoft Internet Explorer 5
Microsoft Internet Explorer 5.5
Microsoft Internet Explorer 6
Mozilla
Netscape 6
Opera 5*
Opera 6*

The latest versions of these browsers can be obtained for free.
Microsoft Internet Explorer can be found at Microsoft.com
Mozilla can be found at Mozilla.org
Netscape can be found at Netscape.com
Opera can be found at Opera.com

*Please Note: Opera is able to identify itself as several different browsers. Please make sure you set Opera to identify as one of the browsers listed above.



SPECIAL CHARACTERS

The "URL" and "Title" may NOT contain any "|" pipe symbols or "&" ampersands since these are used as delimiters.

Some browsers require the use of encoding for special characters (e.g., In older browser versions, a "space" in a text string can be denoted as "%20").  These substitutions MUST be used to ensure compatibility in different browsers. 

Good practice in coding for all browsers is to encode special characters. That is, convert each character in a string that is not an ASCII letter or digit to %HH, where HH is the hexadecimal value of the character. This  includes the hyphen '-' and dot '.' characters passed in a lat or lon float value.
Netscape creates an http request with the exact URL coded in the document, while Internet Explorer (IE) reads the URL and automatically encodes these special characters. Hence, failure to code in this manner can cause a 400  response (malformed request) for Netscape users (especially older Netscape 3.x, 4.x, browsers).
This issue is not unique to the Maptech MapServer
.  


Note: Space characters and ampersand characters(&) must also be encoded. To encode a space replace it with a %20. To encode an ampersand replace it with %26.  

EXAMPLES

http://mapserver.maptech.com/bp/mapserver/index.cfm?
lat=42%2E972818&lon=%2D71%2E981756&type=1&zoom=100&scale=24000&
icon=houseforsale%5Fred%5F64%5F64%5F%2D64%5F%2D64%7C42%2E972818%7C%2D71%2E981756%7C
http%3A%2F%2Fwww%2Ethemollers%2Ecom%2F|
%5EThe%20Moller%27s%20Inc%2E 

click here to view the above example

http://mapserver.maptech.com/bp/mapserver/index.cfm?
bpid=
MAP0060030900&lat=44%2E7483059685&
lon=%2D68%2E8291797973&type=3&zoom=100&scale=20000&
icon=building%5Fred%5F32%5F32%5F%2D16%5F%2D16%7C44%2E7483059685%7C%2D68%2E8291797973%7C%7C
Palmer%2FJadkowski%20Family%20with%20name%20in%20tool%20tip%20and%20no%20Web%20Site%20link

click here to view the above example

back to top 

PROPER USAGE

Maptech reserves the right to disallow any uses of the MapServer or the Maptech site that (a) promote sexually explicit materials; (b) promote violence; (c) promote discrimination based on race, sex, religion, nationality, disability, sexual orientation, or age; (d) infringe on an individuals privacy; (e) promote illegal activities, (f) include "Maptech" or variations or misspellings thereof in their domain names; or (g) otherwise violate intellectual property rights.  Unless otherwise agreed upon in writing, Maptech reserves the right to disallow or block your use of the MapServer at its sole discretion for any reason at any time.

back to top 

 


| MapServer Home | Maptech Home |

CONFIDENTIAL AND PROPRIETARY INFORMATION
Copyright 2000 - 2009 Maptech, Inc., All Rights Reserved.