Maps API for JavaScript Developer's Guide

H.util.ContextItem

Class Summary

Extends: H.util.EventTarget

This class represents a contextual information/action.

[ For full details, see the Class Details ]

Property Summary

Table 1. Properties
Properties

static SEPARATOR : {H.util.ContextItem}

Separator for the context items

Method Summary

Table 2. Methods
Methods

getLabel () : {string}

This method returns label of the context item

setLabel (label) : {H.util.ContextItem}

This method changes context item label to the specified one

isDisabled () : {boolean}

This method returns disabled state of the context item.

setDisabled (disabled) : {H.util.ContextItem}

This method enables/disables the context item

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

Class Description

This class represents a contextual information/action.

Example

// Enable map events, like "contextmenu"
var events = new H.mapevents.MapEvents(map);

// Show default controls as well as the Context Menu control
var ui = H.ui.UI.createDefault(map, defaultLayers, 'en-EN');

// Add 'Zoom in' context menu item
map.addEventListener('contextmenu', function(e) {
  e.items.push(new H.util.ContextItem({
  label: 'Zoom in',
  callback: function() {
    map.setZoom(map.getZoom() + 1);
  }
  }));
});

Constructor Details

H.util.ContextItem(opt_options)

Parameters:
 
opt_options:
{H.util.ContextItem.Options=} [optional]
 
The values to initialize this context item

Property Details

static SEPARATOR: {H.util.ContextItem}

Separator for the context items

Method Details

getLabel () : {string}

This method returns label of the context item

Returns:
 
{string}
the label of the context item

setLabel (label) : {H.util.ContextItem}

This method changes context item label to the specified one

Parameters:
 
label:
{string}
 
New label for the context item
Returns:
 
{H.util.ContextItem}
this context item instance

isDisabled () : {boolean}

This method returns disabled state of the context item.

Returns:
 
{boolean}
true if the item is disabled, false otherwise

setDisabled (disabled) : {H.util.ContextItem}

This method enables/disables the context item

Parameters:
 
disabled:
{boolean}
 
true to disable and false to enabled it
Returns:
 
{H.util.ContextItem}
this context item instance

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.

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.