ALKMaps.Icon

The icon represents a graphical icon on the screen. Typically used in conjunction with a ALKMaps.Marker to represent markers on a screen.

An icon has a url, size and position. It also contains an offset which allows the center point to be represented correctly. This can be provided either as a fixed offset or a function provided to calculate the desired offset.

Summary

ALKMaps.Icon	The icon represents a graphical icon on the screen.
Properties
url	{String} image url
size	{<ALKMaps.Size>\|Object} An ALKMaps.Size or an object with a ‘w’ and ‘h’ properties.
offset	{<ALKMaps.Pixel>\|Object} distance in pixels to offset the image when being rendered.
calculateOffset	{Function} Function to calculate the offset (based on the size)
imageDiv	{DOMElement}
px	{<ALKMaps.Pixel>\|Object} An ALKMaps.Pixel or an object with a ‘x’ and ‘y’ properties.
Constructor
ALKMaps.Icon	Creates an icon, which is an image tag in a div.
Functions
destroy	Nullify references and remove event listeners to prevent circular references and memory leaks
clone	{ALKMaps.Icon} A fresh copy of the icon.
setSize
setUrl
draw	Move the div to the given pixel.
erase	Erase the underlying image element.
setOpacity	Change the icon’s opacity
moveTo	move icon to passed in px.
display	Hide or show the icon
isDrawn	{Boolean} Whether or not the icon is drawn.

Properties

url

{String} image url

size

{<ALKMaps.Size>|Object} An ALKMaps.Size or an object with a ‘w’ and ‘h’ properties.

offset

{<ALKMaps.Pixel>|Object} distance in pixels to offset the image when being rendered. An ALKMaps.Pixel or an object with a ‘x’ and ‘y’ properties.

calculateOffset

{Function} Function to calculate the offset (based on the size)

imageDiv

{DOMElement}

px

{<ALKMaps.Pixel>|Object} An ALKMaps.Pixel or an object with a ‘x’ and ‘y’ properties.

Constructor

ALKMaps.Icon

Creates an icon, which is an image tag in a div.

url	{String}
size	{<ALKMaps.Size>\|Object} An ALKMaps.Size or an object with a ‘w’ and ‘h’ properties.
offset	{<ALKMaps.Pixel>\|Object} An ALKMaps.Pixel or an object with a ‘x’ and ‘y’ properties.
calculateOffset	{Function}

Functions

destroy

destroy: function()

Nullify references and remove event listeners to prevent circular references and memory leaks

clone

clone: function()

Returns

{ALKMaps.Icon} A fresh copy of the icon.

setSize

setSize: function( size )

Parameters

size	{<ALKMaps.Size>\|Object} An ALKMaps.Size or an object with a ‘w’ and ‘h’ properties.

setUrl

setUrl: function( url )

Parameters

url

{String}

draw

draw: function( px )

Move the div to the given pixel.

Parameters

px	{<ALKMaps.Pixel>\|Object} An ALKMaps.Pixel or an object with a ‘x’ and ‘y’ properties.

Returns

{DOMElement} A new DOM Image of this icon set at the location passed-in

erase

erase: function()

Erase the underlying image element.

setOpacity

setOpacity: function( opacity )

Change the icon’s opacity

Parameters

opacity

{float}

moveTo

moveTo: function ( px )

move icon to passed in px.

Parameters

px	{<ALKMaps.Pixel>\|Object} the pixel position to move to. An ALKMaps.Pixel or an object with a ‘x’ and ‘y’ properties.

display

display: function( display )

Hide or show the icon

Parameters

display

{Boolean}

isDrawn

isDrawn: function()

Returns

{Boolean} Whether or not the icon is drawn.