Class MMOverlay

Object
   |
   +--MMOverlay

Direct Known Subclasses:

MMTileLayerOverlay, MMMarkerOverlay, MMInfoBoxOverlay, MMPolyLineOverlay, MMRectangleOverlay

class MMOverlay

Defined in MultimapOpenAPI

Constructor Detail

MMOverlay

MMOverlay()

MMOverlay class, base class for all other overlays. This class defines some functions that must be extended when creating a new overlay.

draw

void draw( <MMViewer> mapviewer )

Abstract function called to make the overlay draw on the map.

Parameters:
mapviewer - The mapviewer that the overlay is added to.

getAttribute

mixed getAttribute( <String> name )

Gets the value for an attribute. The value must be set previously by using setAttribute, otherwise the undefined value will be returned.

Parameters:
name - Name of the attribute to get.

Returns:
The value of the attribute or undefined if it has not been set.

getGeocodingCallback

Function getGeocodingCallback( mapviewer )

Creates a function closure to be used as a callback for geocoding.

Returns:
A function closure.

getZIndex

integer getZIndex( <MMPoint> position, <integer> zIndex )

Retrieves a z-index value for the position passed in. Positions further south should return z-indexes that are larger so that they appear on top of positions further north. Passing in a z-index will allow all items with a specific z-index to appear above items of a different z-index, no matter what the latitude.

Parameters:
position - Position to retrieve the z-index for.
zIndex - The base z-index you want to give, for grouping items.

Returns:
A valid z-index for the position given.

move

void move( <MMPoint> offset )

Function called to move the overlay after a small map move. For better compliance with the Google API this function is optional as this base implementation will call redraw if it isn't overridden.

Parameters:
offset - Offset between old position and new. Positive X means the map centerpoint has moved to the right. Positive Y means the map centerpoint has moved down.

redraw

void redraw()

Abstract function called to redraw the overlay after a large move, zoom factor change or other event that results in a mapviewer redraw.

remove

void remove()

Abstract function called to remove the overlay from the map.

setAttribute

void setAttribute( <String> name, <mixed> value )

Sets an attribute. The Multimap API provides attributes as a place to store information relevant to a marker rather than creating new JavaScript properties that may conflict with internal properties of the marker. Attribute values can contain any valid JavaScript data type. The API will ignore these attributes at all times so the client must do their own memory management (such as removing cyclical references between JS and DOM elements on page unload).

Parameters:
name - Name of the attribute to set.
value - Value to give attribute.