- 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 Index
A
nokia.maps.search.Address
This interface defines a location address, for example a street address.
nokia.maps.util.ApplicationContext
An observeable singleton offering authentication support for services such as search and routing.
B
nokia.maps.kml.BalloonStyle
This class represents the tag defined in the KML specification.It specifies how the balloon containing text, etc.
nokia.maps.map.component.Behavior
Behavior is a collection of user interface components cumulatively responsible for supporting direct user-interaction with the map.
nokia.maps.gfx.BitmapImage
The class
BitmapImage loads a bitmap (PNG, GIF, JPEG and others) from a Web server and makes it available as a GFX image.
nokia.maps.geo.BoundingBox
A bounding box represents a rectangular area in the geographic coordinate system.
nokia.maps.util.Brush
Defines the properties of brush objects that can be used when filling map shapes.
nokia.maps.map.component.InfoBubbles.Bubble
This interface defines a bubble which is shown on the map by an instance of
nokia.maps.map.component.InfoBubbles.
C
nokia.maps.gfx.CanvasPainter
An instance of
CanvasPainter renders a nokia.maps.gfx.IDL object into a DOM node using a CANVAS tag.
nokia.maps.map.Circle
This class defines a map object with a circular shape.
nokia.maps.map.component.panning.Click
This component pans the map when the user clicks in the map.
nokia.maps.gfx.Color
The static
Color class offers methods to handle 32-bit integer color values.
nokia.maps.kml.ColorStyle
This class represents the abstract tag from KML specification.
nokia.maps.map.component.Component
Component is an abstract class that serves as basis for defining replaceable software modules that extend the basic map with additional functionality.
nokia.maps.kml.Container
This class represents the abstract tag from KML specification.
nokia.maps.map.Container
The class
Container groups objects (instances of nokia.maps.map.Object), allowing operations to be performed on them as a unit.
nokia.maps.geo.Coordinate
This class represents a geographical location, a point on the map, defined in terms of its geographical coordinates latitude, longitude and (optionally) altitude.
nokia.maps.util.Coroutine
There are many different ways to run code in a non-blocking way.
nokia.maps.geo.Corridor
Corridor is an interface class.
D
nokia.maps.dom.DataTransfer
This class is a browser-independent implementation of the HTML 5 interface DataTransfer.
nokia.maps.map.Display
This class displays a geographical map, allowing multiple optional layers (containers) and objects such as markers, polylines, polygons, cirles, etc.
nokia.maps.kml.Document
This class represents the tag from KML specification.
nokia.maps.kml.DOM
This is a static class that provides helper methods for the KML-specific classes.
nokia.maps.map.component.zoom.DoubleClick
This class represents a component that zooms the map when the user double clicks into it.
nokia.maps.map.component.zoom.DoubleTap
This class represents a component that zooms in the map view when the user taps twice on the map on a touch screen.
nokia.maps.map.component.panning.Drag
This component enables map dragging with the left mouse button or with the finger on a touch screen.
nokia.maps.dom.DragEvent
This interface represents events fired for all kind of drag operations.
nokia.maps.dom.DragEventTarget
This class is a virtual interface that does exist for documentation purposes.
nokia.maps.map.component.objects.DragMarker
This component implements the default draggability for markers.
E
nokia.maps.dom.Event
The
Event class implements the W3C interface Event.
nokia.maps.map.Object.Event
This class defines the interface that must be supported by all events fired by a
nokia.maps.map.Object or its derived classes, including the nokia.maps.map.Display class.
nokia.maps.dom.EventTarget
The interface class
EventTarget can be implemented as a mixin for any JavaScript class or it can be applied at runtime to any DOM node or JavaScript object by simply casting the node/object to EventTarget.
nokia.maps.util.Coroutine.ExecutionContext
This class represents the execution context of a coroutine.
F
nokia.maps.kml.Feature
This class represents the abstract tag from KML specification.
nokia.Features
The API provides mechanisms to individually load specific features like "routing" or "search".
nokia.maps.kml.FeatureStyle
This class represents a style applicable to the class
Feature.
nokia.maps.dom.FocusEvent
This event is fired if a target receives or loses the focus.
nokia.maps.dom.FocusEventTarget
This class is a virtual interface that exists only for documentation purposes.
nokia.maps.kml.Folder
This class represents the tag from KML specification.
G
nokia.maps.kml.Geometry
This class represents the abstract tag from KML specification.
nokia.maps.map.component.zoom.Gesture
This component will zoom the map if the user makes a zoom gesture at a touch screen.
nokia.maps.gfx.Graphics
This class represents a two-dimensional graphics context.
nokia.maps.gfx.GraphicsImage
The class
GraphicsImage is designed to render images within the client application at run time.
I
nokia.maps.util.IBox
This interface class defines a box with properties that hold the screen coordinates of the sides of the box: top, right, bottom and left.
nokia.maps.util.IBrush
This interface defines a the common properties and methods of a brush object to be used by specific implementations.
nokia.maps.kml.Icon
This class represents the tag from KML specification.
nokia.maps.kml.IconStyle
This class represents the tag from KML specification.
nokia.maps.geo.ICoordinate
This interface defines the properties of an instance of
Coordinate.
nokia.maps.gfx.IDL
IDL is the abbreviation for Image Description Language.
nokia.maps.map.IHitArea
This interface defines the properties of a hit area.
nokia.maps.gfx.Image
This class is an abstract base class for all kinds of image implementations.
nokia.maps.language.Info
The static class
Info provides utilities for managing language support.
nokia.maps.map.component.InfoBubbles
If added to the map, this component manages info bubbles.
nokia.maps.util.IPen
This interface class defines a pen object.
nokia.maps.util.IPoint
This interface defines the property of a point object in a two-dimensional coordinate space.
nokia.maps.geo.IProjection
This class is an interface that provides translations between normalized projected points and geographic coordinates (latitude and longitude).
K
nokia.maps.dom.KeyboardEvent
This event is fired if a key on the keyboard is pressed or released.
nokia.maps.dom.KeyboardEventTarget
This class is a virtual interface that does exist for documentation purposes.
nokia.maps.map.component.panning.Kinetic
This component adds kinetic panning functionality to the map display.
nokia.maps.map.component.panning.KineticMovement
This class represents the state of a kinetic movement as returned by the method
startMovement() of nokia.maps.map.component.panning.Kinetic.
nokia.maps.kml.component.KMLResultSet
This class represents a result set that can be initiated with a response from a KML file request.
L
nokia.maps.kml.LabelStyle
This class represents the tag from KML specification.
nokia.maps.kml.LinearRing
This class represents the tag from KML specification.
nokia.maps.kml.LineString
This class represents the tag from KML specification.
nokia.maps.kml.LineStyle
This class represents the tag from KML specification.
nokia.maps.kml.ListStyle
This class represents the tag from KML specification.
nokia.maps.search.Location
This interface defines a location.
nokia.maps.search.LocationFilter
This interface defines a location filter.
M
nokia.maps.kml.Manager
This class submits XHR requests for KML files and parses a KML document.
nokia.maps.language.Manager
Manager is a service class that provides translation facilities.
nokia.maps.positioning.Manager
This class provides a function set based on the specification of the W3C geolocation API.
nokia.maps.routing.Manager
The Manager acts as a proxy to the routing service and is responsible for storing the currently selected routes.
nokia.maps.search.Manager
The
Manager acts as a proxy to the search service and provides methods for retrieving search results.
nokia.maps.routing.Maneuver
This interface defines a maneuver, which describes an action that a person needs to perform when following a route.
nokia.maps.map.Display.MapViewChangeEvent
A event which is used to signalize changes of a map view.
nokia.maps.map.Marker
A marker represents a location on the map and identifies that location with an icon.
nokia.maps.routing.Mode
This interface defines route modes, types and other options applicable to route calculation.
nokia.maps.dom.MouseEvent
This class represents all mouse-related events.
nokia.maps.dom.MouseEventTarget
This class is a virtual interface that does exist for documentation purposes.
nokia.maps.map.component.zoom.MouseWheel
This class represents a component that zooms in the map view when the user taps twice on the map on a touch screen.
N
nokia.maps.util.animation.None
The linear animation class implements a linear animation so that every frame advances the same amount.
O
nokia.maps.kml.Object
This class represents the abstract <Object> tag from KML specification.
nokia.maps.map.Object
Object is the abstract base class for the map itself and for all visual objects that can be displayed in the map.
nokia.maps.util.OList
This class defines an observable list.
nokia.maps.util.OObject
This class encapsulates an inheritable object that has observable properties.
nokia.maps.map.component.InfoBubbles.Options
This interface defines the properties (options or keys) for
nokia.maps.map.component.InfoBubbles.
nokia.maps.map.Provider.Options
This interface defines properties for the class
Provider.
P
nokia.maps.dom.Page
Page is a special abstract interface that defines a common API for documents.
nokia.maps.gfx.Painter
This class is an abstract base class for all painter implementations.
nokia.maps.kml.Pair
This class represents the tag from KML specification.
nokia.maps.util.Pen
This class defines properties of pen objects that can be used when drawing shape and text.
nokia.maps.geo.PixelProjection
This class provide translations between projected pixel coordinates and geographical coordinates (longitude and latitude).
nokia.maps.search.Place
This interface defines a place object and its properties.
nokia.maps.kml.Placemark
This class represents the tag from KML specification.
nokia.maps.kml.Point
This class represents the tag from KML specification.
nokia.maps.util.Point
This class represents a location within a two-dimensional space.
nokia.maps.kml.Polygon
This class represents the tag from KML specification.
nokia.maps.map.Polygon
This class represents map object that is, in effect, a closed polyline (
nokia.maps.map.Polyline).
nokia.maps.map.Polyline
Polyline represents a visible line on the screen that connects two or more points.
nokia.maps.kml.PolyStyle
This class represents the tag from KML specification.
nokia.maps.positioning.component.Positioning
This class represents a component that switches positioning on and off.
nokia.maps.map.Circle.Properties
This interface defines the properties (keys) that can be passed to the constructor of
nokia.maps.map.Circle.
nokia.maps.map.Container.Properties
This interface defines the properties (keys) that can be passed to the constructor of
nokia.maps.map.Container.
nokia.maps.map.Display.Properties
This interface defines the properties (keys) that can be passed to the map
nokia.maps.map.Display constructor.
nokia.maps.map.Marker.Properties
This interface defines the properties (keys) that can be passed to the constructor of all classes derived from
nokia.maps.map.Marker.
nokia.maps.map.Object.Properties
Interface defining the Properties (keys) that can be passed to the constructor of all classes derived from
nokia.maps.map.Object.
nokia.maps.map.Polygon.Properties
This interface defines the properties (keys) that can be passed to the constructor of
nokia.maps.map.Polygon.
nokia.maps.map.Polyline.Properties
This interface defines the properties (keys) that can be passed to the constructor of
nokia.maps.map.Polyline.
nokia.maps.map.Rectangle.Properties
This interface defines the properties (keys) that can be passed to the constructor for
nokia.maps.map.Rectangle.
nokia.maps.map.Spatial.Properties
This interface defines the properties (keys) that can be passed to the constructor of all classes derived from
nokia.maps.map.Spatial.
nokia.maps.map.StandardMarker.Properties
This interface defines the properties (keys) that can be passed to the
nokia.maps.map.StandardMarker constructor.
nokia.maps.map.Provider
An abstract class representing a map provider.
nokia.maps.geo.Proximity
This interface defines an area of proximity as a geographic area in the shape of a cirlce.
R
nokia.maps.map.Rectangle
The class defines a map object with a rectangular shape.
nokia.maps.util.Rectangle
A Rectangle specifies an area in a two-dimensional coordinate space which is enclosed by the rectangle object's top-left and bottom-right corners.
nokia.maps.map.component.RightClick
RightClick represents a component that adds direct user-interaction to the map.
nokia.maps.routing.component.RightClick
The class
RightClick adds support for direct user interaction to a route displayed on the map.
nokia.maps.search.component.RightClick
The class
RightClick adds support for direct user interaction to a map search facility.
nokia.maps.routing.Route
This interface defines a route.
nokia.maps.routing.component.RouteComponent
The class
RouteComponent acts as an aggregation object for all the services related to defining a routing experience for the map user, including nokia.maps.routing.Manager and nokia.maps.search.Manager.
nokia.maps.routing.RouteLeg
This interface defines a route leg, which represents a section of a route between two consecutive waypoints.
nokia.maps.routing.component.RouteResultSet
This result set can be initiated with a response of a calculate route request and provides some useful methods to handle this response in combination with a map.
nokia.maps.routing.RouteSegment
This interface represents a route segment, a sub-section of a route between two maneuvers.
nokia.maps.routing.RouteSummary
This interface defines a route summary.
S
nokia.maps.util.Coroutine.Scope
The scope represents the variable object of an execution context.
nokia.maps.search.component.SearchResultSet
This class encapsulates the results of a map search.
nokia.maps.routing.ServiceError
This interface represents a routing service error.
nokia.maps.search.ServiceError
This interface represents a search service error.
nokia.maps.geo.Shape
This class represents an observable geographic shape (derived from
nokia.maps.geo.Strip) with a geometry contained in a geographic quadtree and allows testing for containment, square-based clipping and near-by analysis.
nokia.maps.map.Spatial
This is an abstract base class for all objects that have a geo-spatial dimension.
nokia.maps.map.StandardMarker
A StandardMarker represents a location on the map and visibly identifies that location with an icon.
nokia.maps.geo.Strip
This class represents an observable array that stores geographic coordinates in an optimized way and allows specialized operations on them.
nokia.maps.util.Strip
This class represents a special array that contains objects, all of the same type, and each with the same properties.
nokia.maps.kml.Style
This class represents the <Style> tag from KML specification.
nokia.maps.kml.StyleContainer
This class contains an array of
nokia.maps.kml.StyleSelector objects.
nokia.maps.kml.StyleMap
The class
StyleMap maps between two different styles.
nokia.maps.kml.StyleSelector
This class represents the abstract tag from KML specification.
nokia.maps.gfx.SvgParser.SvgMarkupInfo
This is an abstract interface for documentation purpose only.
nokia.maps.gfx.SvgPainter
The SVG painter renders a
nokia.maps.gfx.IDL into a DOM node with an SVG tag.
nokia.maps.gfx.SvgParser
An SVG parser can be used to convert an SVG string into an instance of
nokia.maps.gfx.IDL.
T
nokia.maps.map.component.panning.Tap
This class represents a component that pans the map when the user taps on the map on the touch screen.
nokia.maps.dom.TextEvent
This event is fired if some text is entered from the keyboard, clipboard or from some other source.
nokia.maps.dom.Touch
The
Touch class represents a single touch on the surface of the screen.
nokia.maps.dom.TouchEvent
This interface represents events relating to the user's touching, tapping or dragging on a touch screen, for example, on mobile phones or some computers (such as laptops) that support touch screens.
nokia.maps.dom.TouchEventTarget
This class is a virtual interface that exists only for documentation purposes.
nokia.maps.map.component.TypeSelector
This class defines a user interface component that allows the user to change the current base map type.
V
nokia.maps.kml.Vector2
This class represents the kml:vec2 data type from KML specification.
nokia.maps.util.Vector3D
This class represents a three dimensional vector.
nokia.maps.gfx.VmlPainter
The VML painter renders an instance of
nokia.maps.gfx.IDL into a VML tag to be used with Internet Explorer.
W
nokia.maps.routing.Waypoint
This interface defines a waypoint, which is a point along a route.
nokia.maps.routing.WaypointParameterList
The class
WaypointParameterList wraps a list of waypoints in potentially different representations.
nokia.maps.dom.WheelEvent
This event indicates that a wheel on a pointing device has been rotated and thus it typically reflects the fact that the user has scrolled the mouse wheel, but it may also refer to scrollable elements of other pointing devices, for example trackballs.
Z
nokia.maps.map.component.ZoomBar
The class
ZoomBar defines a component that allows the user to control the map zoom level.