Class MMOverlay

Object
   |
   +--MMOverlay

Direct Known Subclasses:

MMMarkerOverlay, MMInfoBoxOverlay

class MMOverlay

Defined in MultimapAPI

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.

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.