Class MMMarkerOverlay

Object
   |
   +--MMOverlay
         |
         +--MMMarkerOverlay

class MMMarkerOverlay

extends MMOverlay

Defined in MultimapAPI

Field Detail

infoBoxOpened

Object infoBoxOpened

infoBoxOpened is deprecated, is an alias to isInfoBoxOpened.

superclass

<static> Object superclass

MMMarkerOverlay

MMMarkerOverlay( <MMPoint> position, <String> label, <MMIcon> icon, text )

MMMarkerOverlay class, for drawing small markers on the map.

Parameters:
position - Position to place the marker at, in an appropriate coordinate system for the map.
label - (optional) A 'tool tip' to display next to this marker to identify it.
icon - (optional) The icon to use to display the marker, a default icon is used if none is given.

closeInfoBox

void closeInfoBox()

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

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, <String> cssClass, <boolean> dont_move, <boolean> no_combine_classes )

Opens an info box for this marker. Uses the properties given to display an info box at the correct location relative to the marker.

Parameters:
html - HTML to go in the info box, String or HTMLElement.
cssClass - (optional) A class name to assign to the info box.
dont_move - (optional) If true, the map will not move to accommodate the info box.
no_combine_classes - (optional) If true, the passed in CSS class name is used for the widget, rather than combining it with the default - "MMInfoBox".

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