Class MMPolyLineOverlay

Object
   |
   +--MMOverlay
         |
         +--MMPolyLineOverlay

class MMPolyLineOverlay

extends MMOverlay

Defined in MultimapAPI

Constructor Detail

MMPolyLineOverlay

MMPolyLineOverlay( <Array> points, <Object> options )

MMPolyLineOverlay class, for drawing lines on a map. The following options are available for polylines:

Name	Type	Default	Description
opacity	float	0.75	Opacity of the line.
color	String	#0000FF	Color to give the line.
thickness	float	1	Relative thickness that you want the line to have. 1.0 for default thickness, 2.0 for twice as thick, 0.5 for half as thick.
closed	boolean	false	If true then the polyline is closed, making it a polygon.
fill	String		If set to a HTML color string and 'closed' has been set to true, then the polygon is filled with this color (with the same opacity as the line).
clickable	boolean	false	If true then the polyline will generate 'click' events.
active	boolean	false	If true the the polyline will generate 'click', 'mouseover', 'mousemove' and 'mouseout' events.

Parameters:
points - The list of points that you want to draw a line between.
options - A javascript object literal containing options for this polyline.

copy

MMBox copy()

Function to return a copy of this object in another object.

Returns:
A new object containing the same data as this object.

reset

void reset( <Array> points, <Object> options )

Resets the properties of this polyline/polygon.

Parameters:
points - The list of points that you want to draw a line between.
options - A javascript object literal containing options for this polyline.