Powered by Zoomin Software. For more details please contactZoomin

HERE Maps API for JavaScript - API Reference

Filters

Clear All Filters
Product category
Technology
Doc type
Version
Product lifecycle
Clear All Filters
This publication

HERE Maps API for JavaScript - API Reference: Class: Marker

Share
Share to emailCopy article URL
Feedback
Print
Table of Contents
HomeHERE Maps API for JavaScript - API Reference...IndexClass: MarkerCurrent page
Table of Contents

Class: Marker

Share
Share to emailCopy article URL
Feedback
Print

H.map.Marker

new H.map.Marker (position, opt_options)

A Marker is a visual representation of a location on a map in the form of a static bitmap icon.

With the WEBGL engine H.Map.EngineType markers can be elevated from the ground level if altitude is specified. Altitude is defined in meters. Supported maximum value is 32767.

Name Type Description
position H.geo.IPoint | H.geo.MultiPoint

The geographic location(s) of the marker
opt_options H.map.Marker.Options optional

The options to initialize the marker

Extends

Members

draggable boolean inherited

Indicates whether the map object will be considered as target for drag events. The default value is false

Methods

addEventListener (type, handler, opt_capture, opt_scope) inherited

This method adds a listener for a specific event.

Note that to prevent potential memory leaks, you must either call removeEventListener or dispose on the given object when you no longer need it.

addOnDisposeCallback (callback, opt_scope) inherited

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

Name Type Description
callback function

The callback function.
opt_scope Object optional

An optional scope for the callback function

compareZOrder (other)number inherited

This method compares the rendering z-order of the given object with another object. (The 'given object' mean the object on which the method has been invoke.)

Name Type Description
other H.map.Object

The map object with which to compare the given object.
Returns:
Type Description
number A value lower than 0 indicates that the given object has a lower z-order. 0 indicates that both objects have the same z-order. A value greater than 0, indicates that the given object has a higher z-order.

contains (object)boolean inherited

This method checks whether the received object is an inclusive descendant of the given object.

Name Type Description
object *

The object to check.
Returns:
Type Description
boolean true if the given object is contained in the given object, otherwise false

dispatchEvent (evt) inherited

This method dispatches an event on the EventTarget object.

Name Type Description
evt H.util.Event | string

An object representing the event or a string with the event name

dispose () inherited

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

getData ()* inherited

To retrieve arbitrary data associated with the given object.

Returns:
Type Description
* The associated data.

getGeometry ()H.geo.Point | H.geo.MultiPoint inherited

To obtain the marker's location(s). If you modify the obtained geometry, you must call setGeometry(geometry) afterwards to not violate the integrity of the marker.

Returns:
Type Description
H.geo.Point | H.geo.MultiPoint

getIcon ()H.map.Icon | H.map.DomIcon inherited

This method retrieves the current icon associated with the given marker.

Returns:
Type Description
H.map.Icon | H.map.DomIcon

getId ()* inherited

This method retrieves the ID of the given object.

Returns:
Type Description
* The identifier of the given object.

getInvalidations ()H.map.provider.Invalidations inherited

This method retrieves the invalidation states for the given object.

Returns:
Type Description
H.map.provider.Invalidations An object containing the invalidation states

getParentGroup ()H.map.Group inherited

This method retrieves the parent group which contains the given object or null if the object is not contained in any group.

Returns:
Type Description
H.map.Group An object representing the containing group object or null if the given object is not contained in any group.

getProvider ()H.map.provider.ObjectProvider inherited

This method obtains the current provider of the given object.

Returns:
Type Description
H.map.provider.ObjectProvider An object representing the provider

getRemoteId ()number | string | undefined inherited

This method retrieves the remote ID of the given object.

Returns:
Type Description
number | string | undefined The remote identifier of the given object.

getRootGroup ()H.map.Object inherited

The root object to which the given object is attached or the object itself if it is not attached to another.

Returns:
Type Description
H.map.Object An object representing the root group for the given object or the given object if it is not part of a group.

getVisibility (opt_effective)boolean inherited

This method retrieves a value indicating the visibility of the given object.

Name Type Description
opt_effective boolean optional

Indicates whether the effective visibility is requested, defaults to false. If set to true the visibility of all nesting parent groups on the ancestor axis are also taken into account: The object is only visible if the object itself and all of its nesting parent groups are visible.
Returns:
Type Description
boolean A value indicating whether the object is visible

getVolatility (opt_effective)boolean inherited

To obtain the volatility indicator of the object.

Name Type Description
opt_effective boolean optional

Indicates whether the effective volatility is requested, defaults to false. If set to true the volatility of all nesting parent groups on the ancestor axis are also taken into account: The object is volatile if the object itself or at least one of its nesting parent groups is volatile.
Returns:
Type Description
boolean

getZIndex ()number | undefined inherited

This method retrieves the z-index of the given object.

Returns:
Type Description
number | undefined A value reflecting the z-index of the given object.

invalidate (flags)boolean inherited overrides

This method invalidates the given map object.

Name Type Description
flags H.math.BitMask.<!H.map.provider.Invalidations.Flag>

The value indicates the types of invalidations to the given object.
Returns:
Type Description
boolean Indicates whether a validation was executed (only if the object has a provider)

removeEventListener (type, handler, opt_capture, opt_scope) inherited

This method removes a previously added listener from the EventTarget instance.

setData (data)H.map.Object inherited

This method stores arbitrary data associated with the given object.

Name Type Description
data *

The data to be stored
Returns:
Type Description
H.map.Object The given map object itself

setGeometry (geometry)H.map.AbstractMarker inherited

To Set the marker's geographic location(s). If you modify the given geometry afterwards, you must call setGeometry(geometry) again to not violate the integrity of the marker.

Name Type Description
geometry H.geo.IPoint | H.geo.MultiPoint
Throws:

if the given geometry is not valid

Type
H.lang.InvalidArgumentError
Returns:
Type Description
H.map.AbstractMarker the marker itself

setIcon (icon)H.map.AbstractMarker inherited overrides

This method sets the marker icon.

Name Type Description
icon H.map.Icon | H.map.DomIcon

The new marker icon
Throws:
H.lang.InvalidArgumentError
Returns:
Type Description
H.map.AbstractMarker The marker object itself

setRemoteId (id)H.map.Object inherited

This method sets the ID that identifies the given object in a remote service.

Name Type Description
id number | string

The identifier to assign to the given object.
Returns:
Type Description
H.map.Object The given map object itself

setVisibility (opt_visibility)H.map.Object inherited

This method sets the visibility of the given object.

Name Type Description
opt_visibility boolean optional

Indicates whether the map object should be visible, the default value is false.
Returns:
Type Description
H.map.Object The given object

setVolatility (opt_volatility)H.map.Object inherited

To set the volatility indicator of the object

Name Type Description
opt_volatility boolean optional

The volatility value to set, true means volatile, false means non-volatile. The default value is false.
Returns:
Type Description
H.map.Object The given object

setZIndex (zIndex)H.map.Object inherited

This method sets the z-index of the given object.

Name Type Description
zIndex number | undefined

A value indicating the new z-index
Returns:
Type Description
H.map.Object The given object

toGeoJSON (opt_callback)Object inherited

To obtain a GeoJSON Feature object representing the given map object.

Name Type Description
opt_callback function(*) optional

Callback called with the object's data as argument. It must return either a valid JSON object or null which will be set as value for the Feature's properties key.
See:
Throws:

  • If the provided callback is not a function.

    Type
    H.lang.InvalidArgumentError

  • If the callback (if provided) returns an invalid JSON object/null or (if not) the object's data is an invalid JSON object.

    Type
    Error
Returns:
Type Description
Object A GeoJSON Feature or FeatureCollection object representing the given map object.

Type Definitions

H.map.Marker.Options Object

This object encapsulates the configuration options for a Marker.

Properties:
Was this article helpful?
YesNo
TitleResults for “How to create a CRG?”Also Available inAlert