ApiMaps Class Reference

Static Public Member Functions
static void	showCoordinatesOnMap (Position location, int zoom, int maxTime) throws GeneralException
	shows the given geo location on map
static void	showRectangleOnMap (Rectangle rect, int maxTime) throws GeneralException
	shows the given geo rectangle on map
static void	loadGeoFile (String name, String json, int maxTime) throws GeneralException
	loads the given geo layer and adds it on map as overlay
static void	unloadGeoFile (String name, int maxTime) throws GeneralException
	removes the given geo layer from map
static void	unloadGeoFiles (int maxTime) throws GeneralException
	removes all dynamically loaded geo layers from map
static void	switchMap (String loadPath, int maxTime) throws GeneralException
	Unloads current map and loads a new one.

Member Function Documentation

loadGeoFile()

void loadGeoFile ( String name, String json, int maxTime ) throws GeneralException

static

loads the given geo layer and adds it on map as overlay

Parameters

name	sets a string identification for the given overlay
json	string defining the geo layer using geo json standard format
maxTime	Maximum time (in milliseconds) the function can take. If maxTime=0 function execution is not time limited.

Exceptions

GeneralException

the general exception

Remarks

See the json structure of supported geo json

References Api.getInstance(), and Api.getService().

showCoordinatesOnMap()

void showCoordinatesOnMap ( Position location, int zoom, int maxTime ) throws GeneralException

static

shows the given geo location on map

Parameters

location	model.Position instance which contains the location which will be shown on map.
zoom	Distance (in meters) form ground.Range of this parameter should be between 50 and 30000000.
maxTime	Maximum time (in milliseconds) the function can take. If maxTime=0 function execution is not time limited.

Exceptions

GeneralException

the general exception

Remarks

Point with taken location will be shown in the middle of BrowseMap.
BrowseMap is map shown on after clicking Browse Map menu button. BrowseMap allows browse the loaded maps and change zoom.

References Api.getInstance(), and Api.getService().

showRectangleOnMap()

void showRectangleOnMap ( Rectangle rect, int maxTime ) throws GeneralException

static

shows the given geo rectangle on map

Parameters

rect	model.Rectangle instance which contains the rectangle to show on map.
maxTime	Maximum time (in milliseconds) the function can take. If maxTime=0 function execution is not time limited.

Exceptions

GeneralException

the general exception

Remarks

Zoom will be adjusted so that entire rectangle will be shown.
BrowseMap is map shown on after clicking Browse Map menu button. BrowseMap allows browse the loaded maps and change zoom.

References Api.getInstance(), and Api.getService().

switchMap()

void switchMap ( String loadPath, int maxTime ) throws GeneralException

static

Unloads current map and loads a new one.

Parameters

loadPath	Full path to maps folder.
maxTime	Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Exceptions

GeneralException

GeneralException#getCode()

References Api.getInstance(), and Api.getService().

unloadGeoFile()

void unloadGeoFile ( String name, int maxTime ) throws GeneralException

static

removes the given geo layer from map

Parameters

name	the identification of the overlay
maxTime	Maximum time (in milliseconds) the function can take. If maxTime=0 function execution is not time limited.

Exceptions

GeneralException

the general exception

References Api.getInstance(), and Api.getService().

unloadGeoFiles()

void unloadGeoFiles ( int maxTime ) throws GeneralException

static

removes all dynamically loaded geo layers from map

Parameters

maxTime

Maximum time (in milliseconds) the function can take. If maxTime=0 function execution is not time limited.

Exceptions

GeneralException

the general exception

References Api.getInstance(), and Api.getService().