So, you're a developer

OS OpenSpace is currently running as a beta test service.

Frequently Asked Questions

An extensive list of frequently asked questions, covering most technical and licensing issues, is available from our faq section.

Documentation

We have made all of the OS OpenSpace API documentation available to you.

Current Version

API Documentation version 0.7.2

Previous Versions

OS OpenSpace™ API examples

To get you started, here are a few examples of how to use the OS OpenSpace API within your own projects.

Taking the scenario of a surveyor, working in the field, with a number of tasks to undertake. The following examples demonstrate how OS OpenSpace could be used by the surveyor to complete these tasks.

Displaying a marker on the map - pinpoint the surveyor's office.
Displaying a marker on the map via coordinate translation - pinpoint the surveyor's location by converting latitude and longitude coordinates to British National Grid coordinates.
Adding HTML to the marker info window - displaying HTML in the marker info window.
Displaying a line overlay - the route between the surveyor's office and job.
Displaying a polygon overlay - the surveyor's patch.
Changing the marker icon - displaying a custom marker icon on the map.
Displaying the position of the cursor - getting the coordinates of the cursor's position on the map.
Displaying the map pan zoom control in a different position - putting the pan zoom control on the top right.
Displaying the small map pan zoom control - putting the small pan zoom control at the top left.
Using different map options - restricting layers and map area.

Updates and changes

OpenSpace version 0.7.2

API Fixes:

Fixed Info window text appearing blurred in Internet Explorer.
Controls now move when map is resized.
Fix vector layer to flicker less when panning
Fix gazetteer search to return farms after towns and villages.
Fix Screen Overlay to do relative positioning correctly.
Fix to stop sending the wrong event when the map is being dragged.
Fix CSS for copyright layer.

OpenSpace version 0.6

API Changes:

There is a new method OpenSpace.SupportService.getTileCount() that an OpenSpace developer can call to get information on the number of map tiles downloaded and the tile limit.

API Fixes:

Added methods to use or return OpenSpace.MapPoint objects from functions:
- OpenSpace.Layer.WMS.getMapPointFromViewPortPx()
- OpenSpace.Map.getCenter()
- OpenSpace.Map.setCenter()
- OpenSpace.Map.getMapPointFromViewPortPx()
- OpenSpace.Map.getViewPortPxFromMapPoint()
- OpenSpace.Map.getMapPointFromPixel()
- OpenSpace.Map.getPixelFromMapPoint()
- OpenSpace.Map.getMapPointFromLayerPx()
- OpenSpace.Map.getLayerPxFromMapPoint()
Added missing OpenSpace.Icon.clone() method.
Added missing SRS to OpenSpace.MapPoint.clone() method.