Maps API for JavaScript Developer's Guide

H.map.Icon

Class Summary

Extends: H.util.EventTarget

A visual representation of the H.map.Marker.

[ For full details, see the Class Details ]

Method Summary

Table 1. Methods
Methods

getState () : {H.map.Icon.prototype.State}

Returns the icon's bitmap loading state

getBitmap () : {?(HTMLImageElement | HTMLCanvasElement)}

Returns the bitmap of this icon or null if the bitmap is not ready yet (see H.map.Icon#getState)

getSize () : {?H.math.Size}

Returns the size of this icon or null if a size wasn't specified in the constructor's options and the state of this icon is not H.map.Icon.prototype.State.READY

getAnchor () : {?H.math.Point}

Returns the anchor point of this icon or null if an anchor wasn't specified in the constructor's options and the state of this icon is not H.map.Icon.prototype.State.READY.

getHitArea () : {?H.map.HitArea}

Returns the hit area of the icon.

addEventListener (type, handler, opt_capture, opt_scope)

This method allows to listen for specific event triggered by the object. Keep in mind, that you must removeEventListener manually or dispose an object when you no longer need it. Otherwise memory leak is possible.

removeEventListener (type, handler, opt_capture, opt_scope)

This method will removed previously added listener from the event target

dispatchEvent (evt)

This method will dispatch event on the event target object

dispose ()

Removes listeners from this object. Classes that extend EventTarget may need to override this method in order to remove references to DOM Elements and additional listeners.

addOnDisposeCallback (callback, opt_scope)

This method adds callback which is triggered when the object is being disposed

Events Summary

Table 2. Events
Events

statechange : {H.util.Event}

Fired when the icon's bitmap loading state changes, see H.map.Icon#getState

Class Description

A visual representation of the H.map.Marker.

Constructor Details

H.map.Icon(bitmap, opt_options)

Parameters:
 
bitmap:
{!(string | HTMLImageElement | HTMLCanvasElement)}
 
Either an image URL, a SVG markup, an image or a canvas.
opt_options:
{H.map.Icon.Options=} [optional]
 

Method Details

getState () : {H.map.Icon.prototype.State}

Returns the icon's bitmap loading state

Returns:
 
{H.map.Icon.prototype.State}

getBitmap () : {?(HTMLImageElement | HTMLCanvasElement)}

Returns the bitmap of this icon or null if the bitmap is not ready yet (see H.map.Icon#getState)

Returns:
 
{?(HTMLImageElement | HTMLCanvasElement)}

getSize () : {?H.math.Size}

Returns the size of this icon or null if a size wasn't specified in the constructor's options and the state of this icon is not H.map.Icon.prototype.State.READY

Returns:
 
{?H.math.Size}

getAnchor () : {?H.math.Point}

Returns the anchor point of this icon or null if an anchor wasn't specified in the constructor's options and the state of this icon is not H.map.Icon.prototype.State.READY.

Returns:
 
{?H.math.Point}

getHitArea () : {?H.map.HitArea}

Returns the hit area of the icon.

Returns:
 
{?H.map.HitArea}
icon's anchor point

addEventListener (type, handler, opt_capture, opt_scope)

This method allows to listen for specific event triggered by the object. Keep in mind, that you must removeEventListener manually or dispose an object when you no longer need it. Otherwise memory leak is possible.

Parameters:
 
type:
{string}
 
name of event
handler:
{!Function}
 
event handler function
opt_capture:
{boolean=} [optional]
 
if set to true will listen in the capture phase (bubble otherwise)
opt_scope:
{Object=} [optional]
 
scope for the handler function

removeEventListener (type, handler, opt_capture, opt_scope)

This method will removed previously added listener from the event target

Parameters:
 
type:
{string}
 
name of event
handler:
{!Function}
 
previously added event handler
opt_capture:
{boolean=} [optional]
 
if set to true will listen in the capture phase (bubble otherwise)
opt_scope:
{Object=} [optional]
 
scope for the handler function

dispatchEvent (evt)

This method will dispatch event on the event target object

Parameters:
 
evt:
{(H.util.Event | string)}
 
event object or event name

dispose ()

Removes listeners from this object. Classes that extend EventTarget may need to override this method in order to remove references to DOM Elements and additional listeners.

addOnDisposeCallback (callback, opt_scope)

This method adds callback which is triggered when the object is being disposed

Parameters:
 
callback:
{!Function}
 
The callback function.
opt_scope:
{Object=} [optional]
 
An optional scope to call the callback in.

Event Details

statechange: {H.util.Event}

Fired when the icon's bitmap loading state changes, see H.map.Icon#getState

You cannot use this account to purchase a commercial plan on Developer Portal, as it is already associated to plans with different payment methods.

To purchase a commercial plan on Developer Portal, please register for or sign in with a different HERE Account.

Something took longer than expected.

The project should be available soon under your projects page.

Sorry, our services are not available in this region.

Something seems to have gone wrong. Please try again later.

We've detected that your account is set to Australian Dollars (AUD).
Unfortunately, we do not offer checkouts in AUD anymore.
You can continue using your current plan as normal, but to subscribe to one of our new plans,
please register for a new HERE account or contact us for billing questions on selfservesupport@here.com.