Class MMMarkerOverlay

Object
   |
   +--MMOverlay
         |
         +--MMMarkerOverlay

class MMMarkerOverlay

extends MMOverlay

Defined in MultimapAPI

Constructor Detail

MMMarkerOverlay

MMMarkerOverlay( <MMLocation> position, <MMMarkerOptions> options )

MMMarkerOverlay class, for drawing small markers on the map.

Parameters:
position - Position at which to place the marker.
options - (optional) An object containing options for this marker.

closeInfoBox

void closeInfoBox()

Closes the info box attached to this marker. If there is no info box attached to the marker, silently does nothing.

getOption

mixed getOption( <String> name )

Retrieves the value of an option that was set in the constructor or the reset() method.

Parameters:
name - The name of the option.

Returns:
The value of an option.

getPosition

MMLocation getPosition()

Returns the geographical position that the marker is anchored to, as set in the constructor, by reset() or as the result of a marker drag.

Returns:
The current geographical position that the marker is anchored to.

hasInfoBoxContent

boolean hasInfoBoxContent()

Function to detect whether info box content has been assigned to this marker.

Returns:
True if this marker has info box content assigned to it, false otherwise.

isInfoBoxOpened

boolean isInfoBoxOpened()

Used to check whether a marker has an open info box attached.

Returns:
True if an info box is attached and open for this marker, false otherwise.

openInfoBox

MMInfoBoxOverlay openInfoBox( <Object> html, <MMInfoBoxOptions> options )

Opens an info box for this marker. Uses the properties given to display an info box at the correct location relative to the marker. If setInfoBoxContent() has been used to assign info box content to the marker then openInfoBox() can be called with no arguments to open an info box with this content.

Parameters:
html - (optional) HTML to go in the info box, String or HTMLElement.
options - (optional) An object containing options.

Returns:
A reference to the info box that was opened.

reset

void reset( <MMLocation> position, <MMMarkerOptions> options, <Boolean> reopen )

Allows the properties of a marker to be reset.

Parameters:
position - (optional) Position at which to place the marker.
options - (optional) An object containing options for this marker.
reopen - (optional) If true and the infobox is open, the infobox will be reopened after the reset has been completed

setInfoBoxContent

void setInfoBoxContent( <Object> html, <MMInfoBoxOptions> options )

Sets the info box content for a marker. This function allows you to use info boxes without having to set up an event handler. This method must also be used if you are using decluttering by aggregation to enable one info box to pop up for all the markers in a cluster.

Parameters:
html - HTML to go in the info box, String or HTMLElement.
options - (optional) An object containing options.

setVisibility

Object setVisibility( <boolean> visible )

Sets the visibility of a marker; can be used when you just want to quickly hide a marker, rather than completely remove it from the viewer.

Parameters:
visible - True to (re)display the marker, false to hide it.