- Legend to Symbols
-
Namespace
The namespace is really just an object where further objects and their methods and properties are attached bundling up all the functionality using a unique name.
Interface
The Interface is a contract by which the implementing class adheres. It describes a desired behavior and enforces adherence for any class that implements the interface.
Class
Classes define types of objects that will be used by the application.
Method
A function associated with a class or object.
Field
A variable associated with a class or object.
Inherited Method
A function inherited from the parent class. The present documentation scheme differentiates between a direct or indirect inheritance relationship.
Inherited Field
A variable inherited from the parent class. The present documentation scheme differentiates between a direct or indirect inheritance relationship.
Event
Events are actions that occur because of user interaction. They are normally used in combination with functions, and the function will not be executed before the event occurs.
Class nokia.maps.map.Circle
Class Summary
This class defines a map object with a circular shape.
new nokia.maps.map.Circle
(center, radius, props)
Properties
This interface defines the properties (keys) that can be passed to the constructor of
nokia.maps.map.Circle.
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.
getBoundingBox
()
: nokia.maps.geo.BoundingBox
This method calculates the outer bounding box of the given container.
getDisplays
()
: nokia.maps.map.Display[]
This method retrieves the instances of
map.Display to which the given object is connected.
getNearest
(coord)
This method retrieves the point that belongs to the given instance of
Polyline and lies closest to the location specified by the caller.
getNearestIndex
(coord)
This method obtains the index of a point that belongs to the given instance of
Polyline and lies closest to the location 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.
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.IBrush
brush
This property specifies the brush used to fill the shape of the polygon.
nokia.maps.geo.Coordinate
center
An object holding the coordinates of the center of the circle.
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)(, …)]
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.geo.Shape
path
The path to define the shape.
nokia.maps.util.IPen
pen
Gives properties e.g.
Number
precision
This property holds the precision of the circle as a number of segments to be used when drawing the circle.
Number
radius
The radius of the circle in meters.
Number
simplify
The value of this property is specified as a number of pixels and indicates if and how much the rendering result is to be simplified.
Boolean
visibility
A flag that determines the visibility of the given
Object instance.
Number
zIndex
The z-index relative to the container.
Direct Inheritance
Inherited from nokia.maps.map.Circle.Properties:
precision
Indirect Inheritance
Inherited from nokia.maps.map.Polygon.Properties:
brush
Inherited from nokia.maps.map.Polyline.Properties:
pen
Inherited from nokia.maps.map.Spatial.Properties:
simplify
Inherited from nokia.maps.map.Object:
destroy
getBoundingBox
getDisplays
getParent
isAdded
isVisible
CHANGE_SPATIAL
CHANGE_VISUAL
CHANGE_ZINDEX
Inherited from nokia.maps.dom.EventTarget:
addListener
addListenerNS
disableDrag
disableUserSelect
dispatch
enableDrag
enableUserSelect
hitTest
insertListener
insertListenerNS
removeListener
removeListenerNS
draggable
eventListener
isEventTarget
parentNode
parentNodes
Inherited from nokia.maps.dom.MouseEventTarget:
click
dblclick
longpress
mousedown
mouseenter
mouseleave
mousemove
mouseout
mouseover
mouseup
mousewheel
Constructor Detail
This method initializes an instance of nokia.maps.map.Circle.
new nokia.maps.map.Circle(center, radius, props)
Parameters:
| {nokia.maps.geo.Coordinate} | center | An object providing the geographical coordinates of the center of the circle |
| {Number} | radius | A value that provides the length of the radius of the circle in meters |
| {nokia.maps.map.Circle.Properties} | props |
An object that specifies object properties and their initial values (among these,
precision has a significant impact on the shape of the circle - please
see nokia.maps.map.Circle.Properties
|
Method Detail
getBoundingBox
()
: nokia.maps.geo.BoundingBox
This method calculates the outer bounding box of the given container. This means
a bounding box encompassing all the map objects in the container, including all child
containers. If the container does not contain any objects or child containers, the
method returns
null. If the container contains only one object that has
no geographical dimensions, for example an instance of nokia.maps.map.Marker
or nokia.maps.map.StandardMarker, then the returned bounding box may have the
size of zero.
Returns:
| {nokia.maps.geo.BoundingBox} |
The calculated geographic outer bounding box of the given container or
null, if the container has no geographic dimensions.
|
Field Detail