Calling the Interactive Map Tool by URL
The NBN Gateway Interactive Map Tool contains a facility to set up maps by URL. These URLs allow you to link to the IMT with certain information prefilled on the map, and zoomed to the right location. This will allow you to provide links to the IMT from webpages and documentation, and even embed the IMT in your websites.
Get Map URL
By far the easiest way to create a link to a specific map is to use the new Get Map URL button. This button can be found in the top right corner of the Interactive Map screen.
Once you have set up your map with the data you wish your link to display, click on the button and copy the link. You can now use the link whenever you need to return to the map with the same data and filters.
Parameters
The other method of generating URLs for links is to construct them yourself. In the IMT, all parameters are optional, so you can mix and match them to programmatically generate the maps you want.
All URLs start with: http://data.nbn.org.uk/imt/?
Species Data Parameters
There are a number of parameters that support the setup of species data layers. These are described below:
mode
This parameter selects the type of species data to be displayed. The values are:
Value
Description
SPECIES
Single species mapping
SINGLE_DATASET
Dataset species density mapping
DESIGNATION
Designation species density mapping
species
If the mode is set to SPECIES, then this parameter selects the species to be mapped. It has no effect in other modes. The value needs to be set to NHM Dictionary taxon version key for a species. This can be found on the taxonomic information page for the species:
For example: To set up a map with Aeshna Isosceles data the URL would be:
http://data.nbn.org.uk/imt/?mode=SPECIES&species=NBNSYS0000005629
dataset
If the mode is set to SINGLE_DATASET, then this parameter selects the dataset to be mapped. It has no effect in other modes. The value needs to be set to NBN Dataset Key for the dataset. This can be found on the dataset metadata page:
For example: To set up a map with Amphibian & Reptile Licence Return Data from CCW, the URL would be: http://data.nbn.org.uk/imt/?mode=SINGLE_DATASET&dataset=GA000529
designation
If the mode is set to DESIGNATION, then this parameter selects the designation to be mapped. It has no effect in other modes. The value needs to be set to the abbreviation code for the designation. This can be found on the designation metadata page:
For example: To set up a map with EC CITES Annex A data, the URL would be:
http://data.nbn.org.uk/imt/?mode=DESIGNATION&designation=ECCITES-A
Data Filter Parameters
The IMT supports a number of filters to allow you restrict the mapped data further. These are described below:
datasets
Distinct from dataset this allows you to filter the datasets used when compiling species and designation maps. It contains a comma delimited list of NBN Dataset Keys to be used in the mapping.
For example: To set up a map with Aeshna Isosceles data from just the Natural England ‘Invertebrate Site Register’ and RSPB’s ‘Odonata records from RSPB Reserves 1970-2009’ the URL would be:
http://data.nbn.org.uk/imt/?mode=SPECIES&species=NBNSYS0000005629&datasets=GA000163,GA000724
startyear and endyear
These two parameters can be used to restrict the year range for records used on all types of species maps. The year range is from 1800 to the current year. The parameters are independent, you can use none, one or both. The default range is pre-1800 to the current year.
For example: To set up a map with Aeshna Isosceles data for 1877 to 1972 the URL would be:
http://data.nbn.org.uk/imt/?mode=SPECIES&species=NBNSYS0000005629&startyear=1877&endyear=1972
Context and Background Layer Parameters
In addition to species data, the IMT can also be called to display habitat and site boundary layers.
boundary
You can add a site boundary context layer to the IMT map by specifying its dataset key in the boundary parameter. The dataset key can be found on the geographic dataset metadata page. Only one boundary may be specified this way.
For example: To set up a map with Aeshna Isosceles data against Watsonian Vice Counties the URL would be:
http://data.nbn.org.uk/imt/?mode=SPECIES&species=NBNSYS0000005629&boundary=GA000344
habitats
You can add habitat context layers to the IMT map by specifying a comma delimited list of habitat dataset keys in the habitats parameter. The dataset keys can be found on the habitat dataset metadata pages. Only datasets beginning with HL can be used at this time.
For example: To set up a map with Aeshna Isosceles data against Draft Coastal Sand Dunes BAP Priority Habitats
http://data.nbn.org.uk/imt/?mode=SPECIES&species=NBNSYS0000005629&habitats=HL000003
baselayer
This parameter is used to specify which backdrop to use.
The values are:
Value
Description
Hybrid
The default Bing maps hybrid layer
Shaded
The Bing maps shaded roads layer
Aerial
The Bing maps aerial photographs layer
Outline
The coastal and watsonian vice county outline layer
For example: To set up the IMT to use the Outline layer with no data:
http://data.nbn.org.uk/imt/?baselayer=Outline
bbox
If you are interested in a particular area of a map, you can specify the bbox parameter. A bbox is built from two WGS84 coordinates (A and B). Coordinate A represents the bottom left coordinate of the area that you are interested in and Coordinate B represents the top right. The format of the bbox parameter is “bbox=
For example: To focus the Interactive Map Tool on the Isle of Man: