Class MQPoi

Object
   |
   +--MQPoi

class MQPoi

Describes a point of interest (POI) which is best represented as a simple point on the map. Examples are schools, restaurants, airports, hotels, landmarks, and any other type of location that can be described as a point on a map.
Defined in features.js

Field Detail

altStateFlag

Object altStateFlag

dragFlag

Object dragFlag

dragLeft

Object dragLeft

dragTop

Object dragTop

isDragging

Object isDragging

keepRolloverOnDrag

Object keepRolloverOnDrag

labelSpan

Object labelSpan

labelText

Object labelText

leaderLine

Object leaderLine

leaderLineColor

Object leaderLineColor

leaderLineDot

Object leaderLineDot

leaderLineDotIcon

Object leaderLineDotIcon

leaderLineDotImage

Object leaderLineDotImage

mqAltMapIcon

Object mqAltMapIcon

snapback

Object snapback

MQPoi

MQPoi(<MQLatLng> mqLatLng, <MQMapIcon> mqMapIcon)

Constructs a MQPoi object.

Parameters:
mqLatLng - Latitude/Longitude specifying the location of the point on the map.
mqMapIcon - OPTIONAL: if specified the icon that represents this poi else a default icon will be used.

finishDrag

void finishDrag()

getAltIcon

MQMapIcon getAltIcon()

Returns the icon of this poi.

Returns:
the icon of this poi.

See:
- setIcon()

getAltStateFlag

boolean getAltStateFlag()

Returns true if this poi's alt state is true, false otherwise.

Returns:
true if this poi's alt state is true, false otherwise.

See:
- setAltStateFlag()

getDraggable

boolean getDraggable()

Returns the current draggable status of the Poi.

getElement

HTMLElement getElement()

Returns the Element node of this poi.

Returns:
the Element node of this poi.

getIcon

MQMapIcon getIcon()

Returns the icon of this poi.

Returns:
the icon of this poi.

See:
- setIcon()

getInfoWindow

MQInfoWindow getInfoWindow()

Returns a reference to the MQInfoWindow.

Returns:
reference to the MQInfoWindow for this MQPoi.

getKey

string getKey()

Returns the key of this poi.

Returns:
the key of this poi.

See:
- setKey()

getLabel

string getLabel()

Returns the label for this poi.

Returns:
the label for this poi.

See:
- setLabel()

getLabelStyle

CSS2Properties getLabelStyle()

Returns the label style for this poi.

Returns:
the label style for this poi.

getLatLng

MQLatLng getLatLng()

Returns the latitude/longitude coordinate of this poi.

Returns:
the latitude/longitude coordinate of this poi.

See:
- setLatLng()

getLeaderLineColor

string getLeaderLineColor()

Returns the current leader line color of the Poi.

getLeaderLineDotImage

Object getLeaderLineDotImage()

Returns the leader line dot image.

See:
- setLeaderLineDotImage()

getRolloverDrag

Object getRolloverDrag()

Returns the drag status of the rollover.

See:
- setRolloverDrag()

getSnapback

boolean getSnapback()

Returns a current snapback status of this poi when draggable.

isIconVisible

boolean isIconVisible()

Returns true if this poi icon is visible, false otherwise.

Returns:
true if this poi icon is visible, false otherwise.

See:
- setIconVisible()

isLabelVisible

boolean isLabelVisible()

Returns true if this poi label is visible, false otherwise.

Returns:
true if this poi label is visible, false otherwise.

See:
- setLabelVisible()

isRolloverEnabled

boolean isRolloverEnabled()

Returns true if a rollover is enabled for this poi, false otherwise.

Returns:
true if a rollover is enabled for this poi, false otherwise.

See:
- setRolloverEnabled()

isVisible

boolean isVisible()

Returns true if this poi is visible, false otherwise.

Returns:
true if this poi is visible, false otherwise.

See:
- setVisible()

redraw

void redraw()

Redraws this poi.

redrawLabel

void redrawLabel()

Redraws this poi label.

setAltIcon

void setAltIcon(<MQMapIcon> mqAltMapIcon)

Sets the alt icon of this poi. The poi is refreshed on the map.

Parameters:
mqAltMapIcon - The new alt icon for this poi.

See:
- getIcon()

setAltStateFlag

void setAltStateFlag(<boolean> b)

Sets the poi's alt state flag.

Parameters:
b - true to make the alt icon visible, false to make primary icon visible.

See:
- getAltStateFlag()

setDraggable

void setDraggable(<boolean> isEnabled)

Sets the draggable status of the Poi.

Parameters:
isEnabled - - Whether the draggable state is enabled.\
keepRolloverOnDrag - (optional) - Whether to keep a displayed rollover during the drag.

See:
- getDraggable()

setIcon

void setIcon(<MQMapIcon> mqMapIcon)

Sets the icon of this poi. The poi is refreshed on the map.

Parameters:
mqMapIcon - The new icon for this poi.

See:
- getIcon()

setIconVisible

void setIconVisible(<boolean> b)

Makes this poi icon visible or invisible.

Parameters:
b - true to make icon visible; false to make invisible.

See:
- isIconVisible()

setInfoContentElement

void setInfoContentElement(<HTMLElement> contentContainer)

Sets the info window content element for this poi.

Parameters:
contentContainer - A new info window content HTMLElement.

setInfoContentHTML

void setInfoContentHTML(<string> content)

Sets the info window content for this poi.

Parameters:
content - An HTML string for the info window content.

setInfoTitleElement

void setInfoTitleElement(<HTMLElement> titleContainer)

Sets the info window title element for this poi.

Parameters:
titleContainer - A new info window title HTMLElement.

setInfoTitleHTML

void setInfoTitleHTML(<string> title)

Sets the info window title for this poi.

Parameters:
title - An HTML string for the info window title.

setKey

void setKey(<string> key)

Sets the key for this poi. The key is a string identifier for use by the developer.

Parameters:
key - The new key for this poi.

See:
- getKey()

setLabel

void setLabel(<string> label, <string> className)

Sets the label for this poi to the specified label string.

Parameters:
label - The new label string.
className - OPTIONAL: If specified the CSS class for the label, otherwise the default CSS class will be used.

See:
- getLabel()

setLabelVisible

void setLabelVisible(<boolean> b)

Makes this poi label visible or invisible.

Parameters:
b - true to make label visible; false to make invisible.

See:
- isLabelVisible()

setLatLng

void setLatLng(<MQLatLng> mqLatLng)

Sets the latitude/longitude coordinate of this poi. The poi is refreshed on the map.

Parameters:
mqLatLng - The new latitude/longitude coordinate of this poi.

See:
- getLatLng()

setLeaderLineColor

void setLeaderLineColor(<string> c)

Sets the snapback status of the Poi.

Parameters:
c - - Hex value of the color to use for this poi's leaderline..

See:
- getLeaderLineColor()

setLeaderLineDotImage

void setLeaderLineDotImage(<string> url, <int> width, <int> height)

Sets the leader line dot image.

Parameters:
url - Full url to the image.
width - Width of the image.
height - Height of the image.

See:
- getLeaderLineDotDraw

setLevel

void setLevel(<integer> i)

Makes this poi change zIndex to affect visibility.

Parameters:
i - higher to "bring to front"; lower to "push to back".

setRolloverDrag

void setRolloverDrag(<boolean> b)

Sets whether to drag the rollover with the poi. Default is true.

Parameters:
b - True to include the rollover with the poi drag, false otherwise..

See:
- getRolloverDrag()

setRolloverEnabled

void setRolloverEnabled(<boolean> benable)

Enables or disables a rollover for this poi.

Parameters:
benable - true to enable rollover; false to disable rollover.

See:
- isRolloverEnabled()

setSnapback

void setSnapback(snap)

Sets the snapback status of the Poi.

Parameters:
snapback - - Whether the draggable state is enabled.

See:
- getDraggable()

setVisible

void setVisible(<boolean> b)

Makes this poi visible or invisible.

Parameters:
b - true to make visible; false to make invisible.

See:
- isVisible()

showInfoWindow

void showInfoWindow()

Displays map's info window at this location, populated with content for this MQPoi

showRolloverWindow

void showRolloverWindow(e)

Displays map's rollover window at this location, populated with content for this MQPoi