Class MQMapIcon

Object
   |
   +--MQMapIcon

class MQMapIcon

A MQMapIcon encapsulates the image functionality that is used to represent a MQPoi..
Defined in features.js

Constructor Detail

MQMapIcon

MQMapIcon(<MQMapIcon> source)

Constructs a MQMapIcon object. By default the image will be a star, the anchor offset will be the center of the image, and the info window anchor will be the top center of the image.

Parameters:
source - OPTIONAL: If specified this MQMapIcon will be a clone of this parameter.

getAnchorOffset

MQPoint getAnchorOffset()

Returns the anchor offset for this icon. The anchor offset is used to position the icon relative to a single point.

Returns:
the anchor offset for this icon.

See:
- setAnchorOffset()

getElement

HTMLElement getElement()

Returns the Element node of this icon.

Returns:
the Element node of this icon.

getImage

HTMLImageElement getImage()

Returns the image for this icon.

Returns:
the image for this icon.

See:
- setImage()

getInfoWindowAnchor

MQPoint getInfoWindowAnchor()

Returns the info window anchor point for this icon.

Returns:
the info window anchor point for this icon.

See:
- setInfoWindowAnchor()

getShadow

HTMLImageElement getShadow()

Returns the shadow image for this icon.

Returns:
the shadow image for this icon.

See:
- setShadow()

redraw

void redraw()

Redraws this icon.

setAnchorOffset

void setAnchorOffset(<MQPoint> mqPoint)

Sets the anchor offset of this icon. The anchor offset is used to position the icon relative to a single point. Thus, if you would like the icon to be centered on a particular point then the anchor offset should be set to (-iconWidth/2, -iconHeight/2).

Parameters:
mqPoint - The anchor offset.

See:
- getAnchorOffset()

setImage

void setImage( <string> url, <int> width, <int> height, <boolean> recalculateAnchors, <boolean> imgIsPng)

Sets the image for this icon. NOTE: for PNG images the url should end with '.png' OR the 'imgIsPng' parameter should be set to true.

Parameters:
url - The image URL string.
width - The width size of the image in pixels.
height - The height size of the image in pixels.
recalculateAnchors - OPTIONAL: true (default) to recalculate anchor points; false will preserve current anchor points. The recalculated anchor offset will be the center of the image, and the recalculated info window anchor will be the top center of the image.
imgIsPng - OPTIONAL: true if the image is a PNG, false (default) otherwise.

See:
- getImage()

setInfoWindowAnchor

void setInfoWindowAnchor(<MQPoint> mqPoint)

Sets the info window anchor point for this icon.

Parameters:
mqPoint - The info window anchor point.

See:
- getInfoWindowAnchor()

setShadow

void setShadow( <string> url, <int> left, <int> top, <int> width, <int> height, <boolean> imgIsPng)

Sets the shadow image for this icon.

Parameters:
url - The shadow image URL string.
left - The left position of the shadow image in pixels.
top - The top position of the shadow image in pixels.
width - The width size of the shadow image in pixels.
height - The height size of the shadow image in pixels.
imgIsPng - OPTIONAL: true if the image is a PNG, false (default) otherwise.

See:
- getImage()