Nokia Maps API Reference

Contents

Class nokia.maps.map.StandardMarker

Class Summary

A StandardMarker represents a location on the map and visibly identifies that location with an icon. It is very similar in terms of properties and supported functionality to nokia.maps.map.Marker, but in addition, it supports a text label and various text properties for it.

new nokia.maps.map.StandardMarker (coord, props)
Properties This interface defines the properties (keys) that can be passed to the nokia.maps.map.StandardMarker constructor.
Method Summary
addListener (type, listener, useCapture) : Object This method registers an event listener.
addListenerNS (namespaceURI, type, listener, useCapture) : nokia.maps.dom.EventTarget This method registers an event listener for events originating from a specific namespace.
addObserver (key, callback, [context]) : nokia.maps.util.OObject This method registers an observer for the property named by the caller.
destroy () This method cleans up itself and removes the instance from all connected Displays.
disableDrag () : nokia.maps.dom.EventTarget This method disables dragging of this event target, causing this event target not to receive dragstart, drag and dragend events.
disableUserSelect () : nokia.maps.dom.EventTarget This method prevents user selection of text and elements within the event target and prevents the magnifier on the iPhone or other similar mobile devices.
dispatch (evt) : Boolean This method dispatches an event.
enableDrag () : nokia.maps.dom.EventTarget This method enables dragging of this event target and disables the user selection, allowing this event target to receive dragstart, drag and dragend events.
enableUserSelect () : nokia.maps.dom.EventTarget This method allows the user to select text and elements within the event target and allows the magnifier on the iPhone or other similar mobile devices.
click (evt) This event is fired after a mousedown/mouseup sequence at the same target has occurred.
dblclick (evt) This event is fired after two click events have been fired within a certain time period.
dbltap (evt) This event is fired after a two tap events have been fired in a certain amount of time.
drag (evt) This event is fired at the target object of the dragstart event while a drag operation is in propgress.
dragend (evt) This event is fired at the end of a drag operation at the object that was dragged (the target of the dragstart event).
dragenter (evt) This event is fired at an object if the mouse/finger is moved into the visible area of the object during a drag operation.
dragleave (evt) This event is fired at the current drop target if the the mouse/finger leaves the visible area of the target.
dragover (evt) This event is fired at the current drop target while the mouse/finger is on/above the drop target.
dragstart (evt) This event is fired at an object that has the property draggable set to true and after a mousedown/touch has occurred and the mouse/finger was moved at least three pixels.
drop (evt) This event is fired at the current drop target if the mouse button or finger is released on/above it, which means that the dragenter event and the dragover events were canceled, so their preventDefault methods were called and the allowedEffect property matches the dropEffect property.
gesturechange (evt) This high-level event is fired whenever either of the two finger making a gesture is moved, changing the properties of the gesture.
gestureend (evt) This high-level event is fired as soon as the gesture ends, for example because one of the two fingers touching the touch screen are lifted.
gesturestart (evt) This high-level event is fired when two or more fingers touch the touch screen and are used to make a "gesture".
longpress (evt) This event is fired after a mouse button has been pressed for a certain amount of time without starting a drag.
longpress (evt) This event is fired after a finger has been pressed against the screen for a certain amount of time without starting a drag or gesture.
mousedown (evt) This event is fired if a mouse button has been pressed.
mouseenter (evt) This event is fired if the mouse cursor enters the visible area of a node -- it is fired at the node that the mouse has entered.
mouseleave (evt) This event is fired when the mouse cursor leaves the physical area of a node -- it is fired at the node the mouse has left.
mousemove (evt) This event is fired if the mouse is moved.
mouseout (evt) This event is fired if the mouse cursor leaves the visible area of a node -- the event is fired at the node that the mouse has left.
mouseover (evt) This event is fired when the mouse cursor enters the visible area of a node -- the event is fired at the node that is entered.
mouseup (evt) This event is fired if a mouse button has been released.
mousewheel (evt) This event is fired if the mousewheel is moved.
tap (evt) This event is fired after a touchstart and touchend has occurred at the same target and only if neither of the touchstart nor the touchend event has been canceled and no gesture was started in between.
touchend (evt) This event is fired when a finger is lifted from a touch screen.
touchmove (evt) This event is fired when a finger touches and moves on a touch screen.
touchstart (evt) This event is fired when a finger is touches a touch screen.
get (key) : Variant This method retrieves the value of the property with the name provided by the caller.
abstract getBoundingBox () : nokia.maps.geo.BoundingBox This method calculates the outer geographic bounding box of the given object.
getDisplayBoundingBox (display) : nokia.maps.util.Rectangle This method retrieves the bounding box of the marker icon for the display specified by the caller.
getDisplayOffset (display, x, y) The method calculates the pixel offset between the screen coordinates supplied by the caller and those of the given marker.
getDisplays () : nokia.maps.map.Display[] This method retrieves the instances of map.Display to which the given object is connected.
getIconForRendering ([doc]) : nokia.maps.gfx.Image The method returns the icon for the given marker bound to the document specified by the caller.
getParent (display) : nokia.maps.map.Object This method retrieves the parent of the given map object.
hitTest (pageX, pageY) : Boolean This method tests if the given x/y position relative to the document lies within the outer bounding box of the node corresponding to the given EventTarget object.
hitTest (display, x, y, [tolerance]) The method tests if the given marker (its hit area) covers the location specified by the caller.
insertListener (type, listener, useCapture) : Object This method registers an event listener as the first listener in the listener chain.
insertListenerNS (namespaceURI, type, listener, useCapture) : nokia.maps.dom.EventTarget This method registers an event listener for events originating from a specific namespace as the first in the listener chain.
isAdded (display) This method checks if the given map object has been added to the instance of map.Display specified by the caller.
isVisible (display) This method checks if the given map object is visible.
remove (key) : nokia.maps.util.OObject This method removes the property with the name provided by the caller.
removeListener (type, listener, useCapture) : nokia.maps.dom.EventTarget This method removes an event listener.
removeListenerNS (namespaceURI, type, listener, useCapture) : nokia.maps.dom.EventTarget This method removes an event listener for events originating from a specific namespace.
removeObserver (key, callback, context) : nokia.maps.util.OObject This method removes the observer for the property named by the caller.
set (nameOrObject, [value, [force]]) : nokia.maps.util.OObject This method sets property values, using the property names and values supplied by the caller.
Field Summary
Number CHANGE_SPATIAL Represents the invalidation type for spatial changes.
Number CHANGE_VISUAL Represents the invalidation type for visual changes.
Number CHANGE_ZINDEX Represents the invalidation type for zIndex changes.
nokia.maps.util.IPoint anchor The anchor point of this marker.
nokia.maps.util.IBrush brush This property holds the color of the interior of the shape in which the marker's text label is rendered.
nokia.maps.geo.Coordinate coordinate The coordinates the marker points to.
Boolean draggable This property indicates if the given event target is draggable and may receive a dragstart, drag and dragend events (true); false otherwise.
Object eventListener This property is either undefined or holds a hash table that, for every event type, contains an array with the elements: [(listener, useCapture, namespaceURI)(, listener, useCapture, namespaceURI)(, …)]
nokia.maps.map.IHitArea hitArea The (optional) hit area of the Marker.
nokia.maps.gfx.Image | Image | String icon The image that indicates the marker's location on the map (makes the marker visible).
Boolean isEventTarget This property indicates whether an object implements the nokia.maps.dom.EventTarget interface (true>) or not (false).
nokia.maps.dom.EventTarget parentNode This property holds a reference to the parent node of the event target (if set).
Object parentNodes If this property is set it holds a hash table that contains the "namespaceURI" as key and the corresponding value is the parent node of the given event target.
nokia.maps.util.IPen pen This property holds the color of the outline of the shape in which the marker's text label is rendered.
String shape This property specifies the shape that is used to display the marker label.
String text This property holds the text (label) rendered in the center of the shape.
nokia.maps.util.IPen textPen This property holds the color of the text in the marker's label.
Boolean visibility A flag that determines the visibility of the given Object instance.
Number zIndex The z-index relative to the container.
Constructor Detail

This method creates an instance of StandardMarker.

new nokia.maps.map.StandardMarker(coord, props)
Parameters:
{nokia.maps.geo.Coordinate} coord An object containing the geographical coordinates of the marker
{nokia.maps.map.StandardMarker.Properties} props The initial values of marker properties
Documentation generated on Thu Feb 09 2012 12:59:06 GMT+0100 (CET).