Gets or sets the autCloseInfo flag, which indicates whether to close info window automatically when user clicks somewhere on the map.

Gets or sets the autInfo flag, which indicates whether to open info window automatically upon mouse click.

Gets or sets the data parameter of the Overlay.

Gets or sets the description text of the Overlay.

Gets or sets Overlay's draggable property.

Indicates whether Overlay is being dragged at the moment.

Return referens to opened InfoWindow

Gets or sets the info window param object.

Gets or sets the info window style object associated with the Overlay.

Gets or sets the name of the object.

Returns the position of the Overlay in bitmap coordinates.

Gets or set the geographical position of the Overlay.

Gets or sets the smartPosition flag, which indicates whether to use smart positioning with the Overlay.

The default value is true.

Gets or sets the Overlay's visibility.

Gets or sets zIndexAuto property which indicates wheter Overlay should be brought to front on mouse over event.

The default value is false.

Overlay constructor.

Creates new Overlay object with the default parameters. Properties defined in param object will override the default values. You can also specify a style object that will be saved in protected style property.

Here is a list of properties you can specify in the param object:

Adds a built-in listener for MouseEvents fired by an InteractiveObject contained in the Overlay.

Brings target Overlay to the top of the parent's display list.

Creates an exact copy of this Overlay and returns it to the user. Please note that it doesn't attach new Overlay to the same or any other parent.

Closes info window that is currently opened.

Releases all the resources accuired by the object.

Starts Overlay dragging.

Stops Overlay dragging.

Fetches Overlay's common properties from XML object in KML 2.1 format. The values are set for the object specified in the first parameter.

  <Placemark id="ID">
    <name>Placemark name</name>                        <!-- string -->
    <description>Placemark description</description>   <!-- string -->
    <visibility>1/0</visibility>                       <!-- boolean -->
  </Placemark>

Retruns Overlay bounds in geographical coordinates.

Retruns Overlay bounds in bitmap coordinates. Use zoom parameter to specify zoom level for bounds conversion.

Returns a copy of the style object.

Hides overlay. Fires OverlayEvent.HIDE & OverlayEvent.CHAGNED events if visibility has been changed.

Schedules the Overlay for invalidation in 1 frame after this call.

Opens new info window with the specified parameters & style. Info window is placed in the center of the object.

Default info window parameters are stored in _infoParam property, but can be overriden by param parameter of the function call. Also you can define the default autoClose value within the parent layer's infoParam object.

Style objects will be concatinated. Here is the order of concatination:

Redraws the overlay.

Override this method in your subclass and call super.redraw() immediately before actual redraw so that OverlayEvent.BEFORE_REDRAW event will be automatically fired. At the end of your drawing don't forget to manually fire OverlayEvent.REDRAW event.

Refreshes overlay position on the map. If the full paramter is set to true then bitmap coordinates for this overlay are recalculated. Otherwise overlay will be repositioned using previuosly calculated coordinates.

Removes a built-in listener for MouseEvents fired by an InteractiveObject contained in the Overlay.

Sets the style for this Overlay from an Object or another Style. After setting the style, Overlay will be invalidated.

Shows overlay. Fires OverlayEvent.SHOW & OverlayEvent.CHAGNED events if visibility has been changed.

Builds an XML object in KML 2.1 format that describes the Overlay & it's style. Flag full indicates whether to build a complete KML data or just a container.

Invoked when map center has been updated.

Invoked when map zoom has been updated.

Dispatched when the InfoWindow has been closed with the Overlay

The OverlayEvent.INFO_WINDOW_CLOSED constant defines the value of the type property of an infoWindowClosed event object.

This event has the following properties:

Dispatched when the InfoWindow has been opened with the Overlay

The OverlayEvent.INFO_WINDOW_OPENED constant defines the value of the type property of an infoWindowOpened event object.

This event has the following properties:

Dispatched when an Overlay position is about to be refreshed. Use param property of the OverlayEvent object to check whether full refresh will be performed.

Dispatched when overlay has been added to a MapObjectContainer, e.g. Layer.

The OverlayEvent.ADDED constant defines the value of the type property of an overlayAdded event object.

This event has the following properties:

Dispatched when an Overlay is about to be invalidated.

The OverlayEvent.BEFORE_REDRAW constant defines the value of the type property of an overlayBeforeRedraw event object.

This event has the following properties:

Dispatched when an Overlay has been changed. Use param property of the OverlayEvent object to get the name of the property that has been changed.

The OverlayEvent.CHANGED constant defines the value of the type property of an overlayChange event object.

This event has the following properties:

Dispatched when user drags an Overlay.

The OverlayEvent.DRAG constant defines the value of the type property of an overlayDrag event object.

This event has the following properties:

Dispatched when user starts dragging an Overlay.

The OverlayEvent.DRAG_START constant defines the value of the type property of an overlayDragStart event object.

This event has the following properties:

Dispatched when user stops dragging an Overlay.

The OverlayEvent.DRAG_STOP constant defines the value of the type property of an overlayDragStop event object.

This event has the following properties:

Dispatched when an Overlay has become invisible. This event is triggered only when user uses the hide() method.

The OverlayEvent.HIDE constant defines the value of the type property of an overlayHide event object.

This event has the following properties:

Dispatched when user presses a mouse button over an Overlay.

The OverlayEvent.MOUSE_DOWN constant defines the value of the type property of an overlayMouseDown event object.

This event has the following properties:

Dispatched when user moves the mouse over an Overlay.

The OverlayEvent.MOUSE_MOVE constant defines the value of the type property of an overlayMouseMove event object.

This event has the following properties:

Dispatched when user releases a mouse button over an Overlay.

The OverlayEvent.MOUSE_UP constant defines the value of the type property of an overlayMouseUp event object.

This event has the following properties:

Dispatched when an Overlay enters ready state. This happens after overlay becomes attached to a parent object.

The OverlayEvent.READY constant defines the value of the type property of an overlayReady event object.

This event has the following properties:

Dispatched when an Overlay has been invalidated.

The OverlayEvent.REDRAW constant defines the value of the type property of an overlayRedraw event object.

This event has the following properties:

Dispatched when an Overlay position has been refreshed. Use param property of the OverlayEvent object to check whether full refresh has been performed.

The OverlayEvent.REFRESH constant defines the value of the type property of an overlayRefresh event object.

This event has the following properties:

Dispatched when user rolls out an Overlay.

Dispatched when user rolls over an Overlay.

The OverlayEvent.ROLL_OVER constant defines the value of the type property of an overlayRollOver event object.

This event has the following properties:

Dispatched when an Overlay has become visible. This event is triggered only when user uses the show() method.

The OverlayEvent.SHOW constant defines the value of the type property of an overlayShow event object.

This event has the following properties: