Class QMap

Object
   |
   +--GMap2
         |
         +--AbstractQMap
               |
               +--QMap

class QMap

extends AbstractQMap

Field Detail

DRAW

<static> Object DRAW

Static property for 'draw lines' drawing mode

MARKERS

<static> Object MARKERS

Static property for 'normal' drawing mode

SCRIBBLE

<static> Object SCRIBBLE

Static property for 'scribble' drawing mode

QMap

QMap(<HTMLDivElement> container, <Object> opts)

The map object -- instantiated to place a map on a page.

Parameters:
container - HTML div containing the map
opts - An options object, documented above.

addOverlay

void addOverlay(<Overlay> overlay, noDataAdd)

Add overlay to the map. Performs necessary actions for later editing.

Parameters:
overlay - A map overlay.

centerOnGeoText

void centerOnGeoText(<String> text)

Geocode the input text and center the map on the first response. Uses the google geocoder

Parameters:
text - The text to geocode.

clearOverlays

void clearOverlays()

Clear overlays from the map. Performs necessary actions for later editing.

disableEditing

void disableEditing()

Disable map editing

editingEnabled

Object editingEnabled()

Test whether or not editing is enabled on the map

Returns:
true if editing is enabled, false otherwise

enableEditing

void enableEditing()

Enable map editing

getDrawingColour

Object getDrawingColour()

Get the current drawing colour

Returns:
the current drawing colour, as a '#RRGGBB' string

getDrawingMode

Object getDrawingMode()

Get the current drawing mode.

Returns:
the current drawing mode. One of QMaps.SCRIBBLE, QMaps.DRAW, or QMaps.MARKERS.

getDrawingWidth

Object getDrawingWidth()

Get the current drawing width

Returns:
the current drawing width in pixels

getGpx

Object getGpx()

Get a string of GPX text representing the map data

Returns:
a string of GPX text describing the map data

getJSON

Object getJSON()

Get the JSON text representing the map data

Returns:
a JSON-formatted string representing the map data

getKml

Object getKml()

Get a string of KML text representing the map data

Returns:
a string of KML text describing the map data

getObject

Object getObject()

Get a JavaScript data object representing the map data

Returns:
an object representing the map data

getXml

Object getXml()

Get the QMaps XML text representing the map data

Returns:
a string of XML describing the map data

importJSON

void importJSON(<String> json)

Import the json-formatted string. Previous data is not cleared.

Parameters:
json - The json data string to display on the map.

importObject

void importObject(<Object> obj)

Import map data from the QMaps JavaScript object.

Parameters:
obj - a properly constructed JavaScript object

importXml

void importXml(<String> xml)

Import the xml data onto the map. Previous data is not cleared.

Parameters:
xml - The xml data string to display on the map.

loadXml

void loadXml(<String> url, <Boolean> append)

Set the xml data on the map by loading the data from a URL

Parameters:
url - The url to load. Must be local to the host displaying the map due to Ajax remote file restrictions.
append - If true, append xml content to current map. If false, over-write current map data.

setDrawingColour

void setDrawingColour(<String> colour)

Set the drawing colour.

Parameters:
colour - The drawing colour

setDrawingMode

void setDrawingMode(<String> mode)

Set the map drawing mode.

Parameters:
mode - One of QMaps.SCRIBBLE, QMaps.DRAW, or QMaps.MARKERS

setDrawingWidth

void setDrawingWidth(<String> width)

Set the drawing width.

Parameters:
width - The drawing width

setJSON

void setJSON(<String> json)

Set the map data according to the json-formatted string. Clears previous data.

Parameters:
json - The json data string to display on the map.

setObject

void setObject(<Object> obj)

Set the map according to the QMaps JavaScript object.

Parameters:
obj - a properly constructed JavaScript object

setXml

void setXml(<String> xml)

Set the xml data on the map. Clears all previous data.

Parameters:
xml - The xml data string to display on the map.